POLYV 工具函数库

本项目提供 Web 前端常用的底层工具函数库，主要用于 POLYV 各类 Web 产品。

安装

``
npm install @polyv/utils
`

NPM 包同时提供了 ES 模块以及 CommonJS 模块，分别位于 es 和 cjs 两个文件夹。它们使用上的区别和优缺点在于：

| 模块类型 | Tree shaking | Babel 编译 |
| --- | --- | --- |
| ES 模块 | 有效，只有用到的代码会被打包 | 需要 |
| CommonJS 模块 | 无效，依赖的文件会被整个打包 | 不需要 |

使用

$3

以 Vue CLI 3.x 创建的项目为例，编辑 vue.config.js 增加相关配置：

` javascript
module.exports = {
// 省略其他配置

configureWebpack: {
resolve: {
alias: {
// 配置别名缩短引用路径
'@utils': path.resolve(__dirname, './node_modules/@polyv/utils/es')
}
}
},

// ES 模块需要 Babel 转译
transpileDependencies: [
'@polyv/utils'
]
};
`

在项目代码中引入：

` javascript
import { cutStr } from '@utils/string';
import Countdown from '@utils/countdown';
`

$3

以 create-nuxt-app 创建的项目为例，编辑 nuxt.config.js 增加相关配置：

` javascript
module.exports = {
// 省略其他配置

build: {
// ES 模块需要 Babel 转译
transpile: [
'@polyv/utils'
]
},

extend(config, ctx) {
// 配置别名缩短引用路径
config.resolve.alias['@utils'] = path.resolve(
__dirname, './node_modules/@polyv/utils/es'
);
}
};
`

在项目代码中引入：

` javascript
import { cutStr } from '@utils/string';
import { Countdown } from '@utils/countdown';
`

兼容性

- 模块变更：
- 原 lang 模块已移除，可以使用 @just4/util 或 lodash-es 代替。
- 原 browser 模块已移除，可以使用 @just4/ua-info 代替。
- 原 cookie 模块已移除，可以使用 @just4/cookie 代替。
- 原 polling 模块已移除，可以使用 @just4/polling 代替。
- 原 storage 模块已移除，可以使用 @just4/storage 代替。
- 部分 API 的变更：
- boolean 模块的 ynToBool 支持指定默认值。
- countdown 模块的 Countdown 类增加 pause 方法。
- string 模块的 cutStr、strLen 两个方法的选项，不再支持 mode 属性。
- string 模块新增 uuidV4 方法。
- validate 模块的 isPhoneNO 方法改名为 isChsPhoneNO。
- CommonJS 模块的路径是 cjs（原来是 dist），ES 模块的路径是 es`（原来是 src）。