zyb-utils
zyb-utils作业帮级别的通用工具类库，大部分来之fis项目的common/widget/util文件夹下的脚本.
须知
zyb-utils依赖一些三方的类库，需要宿主环境提供:
- axios - 一个基于promise 的HTTP 库，可以用在浏览器和node.js 中。
安装
zyb-utils编译 需要 Node.js v4+ 以上版本.
$ npm install --save zyb-utilsutils列表
####browser
方法:chrome() 功能： 检测浏览器是否为 Chrome. 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| 无 | 无 | 无 | 无 | 无 | 无 |
返回： Chrome 版本号(非 Chrome 浏览器返回 undefined)。
方法:firefox() 功能： 检测浏览器是否为 Firefox. 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| 无 | 无 | 无 | 无 | 无 | 无 |
返回： Firefox 版本号(非 Firefox 浏览器返回 undefined)。
方法:ie() 功能： 检测浏览器是否为 IE. 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| 无 | 无 | 无 | 无 | 无 | 无 |
返回： IE 版本号(非 IE 浏览器返回 undefined)。
方法:safari() 功能： 检测浏览器是否为 Safari. 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| 无 | 无 | 无 | 无 | 无 | 无 |
返回： Safari 版本号(非 Safari 浏览器返回 undefined)。
方法:isStandard() 功能： 检测文档是否启用“标准模式”渲染。 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| 无 | 无 | 无 | 无 | 无 | 无 |
返回： 检测结果。
方法:isGecko() 功能： 检测浏览器的排版引擎是否为 gecko. 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| 无 | 无 | 无 | 无 | 无 | 无 |
返回： 检测结果。
方法:isWebkit() 功能： 检测浏览器的排版引擎是否为 webkit. 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| 无 | 无 | 无 | 无 | 无 | 无 |
返回： 检测结果。
方法:os() 功能： 获取用户操作系统类型。 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| 无 | 无 | 无 | 无 | 无 | 无 |
返回： 描述用户操作系统类型的字符串。
方法:kernel() 功能： 获取用户浏览器内核类型。 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| 无 | 无 | 无 | 无 | 无 | 无 |
返回： 描述用户浏览器内核类型的字符串。
####checkCSS
方法:checkCSS(cssProperty) 功能： 检测 CSS 属性的浏览器支持情况(参阅下文详述)。 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| cssProperty | Object | 可选 | 无 | 无 | 无 |
返回： 基于源属性得到的当前浏览器支持的属性名。
####colorExt
方法:getStdHue(index) 功能： 获取标准 12 色相中的某一色值(以 HEX 形式返回)。 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| index | Object | 可选 | 无 | 无 | 无 |
返回： HEX 形式的色值表示。
方法:rgbToHex() 功能： 将 RGB 形式的色值转换成 HEX 形式。 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| color | Object | 可选 | 无 | 无 | 无 |
返回： 转换为 HEX 形式的色值表示。
方法:toRgb() 功能： 将 HEX 或 HSL 形式的色值转换成 RGB 形式。 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| color | Object | 可选 | 无 | 无 | 无 |
返回： 转换为 RGB 形式的色值表示。
方法:toHsl() 功能： 将 HEX 或 RGB 形式的色值转换成 HSL 形式。 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| color | Object | 可选 | 无 | 无 | 无 |
返回： 转换为 HSL 形式的色值表示。
方法:getR() 功能： 获取 HEX 或 HSL 形式色值的红色通道分量(R)。 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| color | Object | 可选 | 无 | 无 | 无 |
返回： 红色通道分量。
方法:getG() 功能： 获取 HEX 或 HSL 形式色值的绿色通道分量(G)。 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| color | Object | 可选 | 无 | 无 | 无 |
返回： 绿色通道分量。
方法:getB() 功能： 获取 HEX 或 HSL 形式色值的蓝色通道分量(B)。 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| color | Object | 可选 | 无 | 无 | 无 |
返回： 蓝色通道分量。
方法:getH() 功能： 获取 HEX 或 RGB 形式色值的色相(H)。 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| color | Object | 可选 | 无 | 无 | 无 |
返回： 色相。
方法:getS() 功能： 获取 HEX 或 RGB 形式色值的饱和度(S)。 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| color | Object | 可选 | 无 | 无 | 无 |
返回： 饱和度。
方法:getL() 功能： 获取 HEX 或 RGB 形式色值的明度(L)。 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| color | Object | 可选 | 无 | 无 | 无 |
返回： 明度。
方法:lighten(color,amount) 功能： 增加 HEX 或 RGB 形式色值的明度。 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| color | Object | 可选 | 无 | 无 | 无 |
| amount | Object | 可选 | 无 | [0, 100] | 无 |
返回： 增加明度后的色值(参阅下文详述)。
方法:darken(color,amount) 功能： 降低 HEX 或 RGB 形式色值的明度。 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| color | Object | 可选 | 无 | 无 | 无 |
| amount | Object | 可选 | 无 | [0, 100] | 无 |
返回： 降低明度后的色值(参阅下文详述)。
方法:fade(color,opacity) 功能： 获取色值的具透明度表示(rgba 形式，参阅下文详述)。 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| color | Object | 可选 | 无 | 无 | 无 |
| opacity | Object | 可选 | 无 | [0, 100]，0 时完全透明，100 时完全不透明 | 无 |
返回： 具透明度的色值表示。
####cookieExt
方法:get(key) 功能： 按 cookie 的键名获取其值 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| key | Object | 必选 | 无 | 无 | 无 |
返回： value
方法:set(key,value,option) 功能： 按 cookie 的键名设定其值 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| key | Object | 必选 | 无 | 无 | 无 |
| value | Object | 必选 | 无 | 无 | 无 |
| option | Object | 可选 | 无 | 无 | 无 |
| expires | Number | 可选 | 无 | 无 | 生命周期 |
| path | String | 可选 | 无 | 无 | cookie 所在目录 |
返回： 无
方法:remove(key) 功能： 按 cookie 的键名删除 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| key | Object | 必选 | 无 | 无 | 无 |
返回： 无
####frameAni
方法:frameAni() 功能： 获取浏览器支持的逐帧动画相关方法。 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| 无 | 无 | 无 | 无 | 无 | 无 |
返回： 逐帧动画相关方法(参阅下文详述)。
####guid
方法:guid(len) 功能： 生成 GUID. 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| len | Object | 可选 | 7，取值范围：[1, 32] | [1, 32] | 无 |
返回： GUID。
####hybrid
方法:hybrid(action,args,callback) 功能： App hybrid 调用. 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| action | Object | 可选 | 无 | 无 | 无 |
| args | Object | 可选 | 无 | 无 | 无 |
| callback | Object | 可选 | 无 | 无 | 无 |
返回： 无。
####invokeApp
方法:invokeApp(uri,onFail,onSuccess) 功能： 调起本地 app. 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| uri | Object | 可选 | 无 | 无 | 无 |
| onFail | Object | 可选 | 无 | 无 | 无 |
| onSuccess | Object | 可选 | 无 | 无 | 无 |
返回： 无。
####invokeAppbyUniversal
方法:invokeApp(uri,onFail,onSuccess) 功能： 调起本地 app. 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| uri | Object | 可选 | 无 | 无 | 无 |
| onFail | Object | 可选 | 无 | 无 | 无 |
| onSuccess | Object | 可选 | 无 | 无 | 无 |
| landingPage | Object | 可选 | 无 | 无 | 无 |
返回： 无。
####numExt
方法:split(num,delimiter,len) 功能： 以指定定界符，按指定长度分隔数值。 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| num | Object | 必选 | 无 | 无 | 无 |
| delimiter | Object | 可选 | ',' | 无 | 无 |
| len | Object | 可选 | 3 | 无 | 无 |
返回： 格式化后的数值串。
方法:pad(num,len,char) 功能： 使用指定填充符(串)给数值添加前缀，使其达到指定长度。 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| num | Object | 必选 | 无 | 无 | 无 |
| len | Object | 可选 | 0，即不对传入的数字添补前缀 | 无 | 无 |
| char | Object | 可选 | '0'；参阅下文详述 | 无 | 无 |
返回： 格式化后的数值串。
方法:toCN(num,useCap) 功能： 将指定数值转换为中文数值(读法)。 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| num | Object | 必选 | 无 | 无 | 无 |
| useCap | Object | 可选 | false | 无 | 无 |
返回： 转换后的中文数值串。
方法:getSerialNums(len,startVal) 功能： 获取有序数值序列(等差为 1 的单调递增序列)。 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| len | Object | 可选 | 0 | 无 | 无 |
| startVal | Object | 可选 | 0 | 无 | 无 |
返回： 生成的数值序列。
方法:getRandomNums(len,valRange,onlyInt) 功能： 获取随机数值序列(参阅下文详述)。 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| len | Object | 可选 | 0 | 无 | 无 |
| valRange | Object | 可选 | [0, 1]，区间左闭右开 | 无 | 无 |
| onlyInt | Object | 可选 | false | 无 | 无 |
返回： 生成的数值序列(或单个数值)。
方法:toPrice(num,decLen,useSplit) 功能： 将数值格式化为价格形式。 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| num | Object | 可选 | 0 | 无 | 无 |
| decLen | Object | 可选 | 2，取值范围：[0, +∞) | [0, +∞) | 无 |
| useSplit | Object | 可选 | true | 无 | 无 |
返回： 格式化后的价格字符串。
####safeCall
方法:safeCall(fun,args,thisArg) 功能： 函数调用器(参阅下文详述)。 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| fun | Object | 可选 | 无 | 无 | 无 |
| args | Object | 可选 | 无 | 无 | 无 |
| thisArg | Object | 可选 | null | 无 | 无 |
返回： 被调用函数返回的结果。
####share
####systemInfo
####terminalCheck
####urlExt
方法:queryToJson(url,shouldDecode) 功能： 将编码在 url query 中的数据转换成 json 格式。 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| url | Object | 可选 | 无 | 无 | 无 |
| shouldDecode | Object | 可选 | true；请参阅下文详述 | 无 | 无 |
返回： 编码成 json 格式的数据。
方法:jsonToQuery(json,shouldEncode) 功能： 将 json 对象(plain object)转换为可用于 url query 编码的字符串(请参阅下文详述)。 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| json | Object | 可选 | 无 | 无 | 无 |
| shouldEncode | Object | 可选 | true | 无 | 无 |
返回： 转换成 url query 格式的数据。
方法:getQuery(qName,url) 功能： 从指定 url 中查询指定的 query(参阅下文详述)。 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| qName | Object | 可选 | 无 | 无 | 无 |
| url | Object | 可选 | 无 | 无 | 无 |
返回： 查询到的 query 值。
方法:setQuery(qName,qValue,url) 功能： 在指定 url 中设置指定的 query。 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| qName | Object | 可选 | 无 | 无 | 无 |
| qValue | Object | 可选 | 无 | 无 | 无 |
| url | Object | 可选 | 无 | 无 | 无 |
返回： 更新后的 query 部分。
方法:setQuery(queries,url) 功能： 在指定 url 中设置指定的(多个) query。 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| queries | Object | 可选 | 无 | 无 | 无 |
| url | Object | 可选 | 无 | 无 | 无 |
返回： 更新后的 query 部分。
####zybImgCompress
方法:zybImgCompress(imageUrl,width,height,quality) 功能： 生成图片 src. 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| imageUrl | Object | 必选 | 无 | 无 | 无 |
| width | Object | 可选 | 无 | 无 | 无 |
| height | Object | 可选 | 无 | 无 | 无 |
| quality | Object | 可选 | 80，可选值：(0-100] | 无 | 无 |
返回： 生成的图片 src.
####zybImgSrc
方法:zybImgSrc(urlOrPid,urlPrefix) 功能： 生成图片 src. 参数：
| 参数名 | 类型 | 必要性 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| urlOrPid | Object | 必选 | 无 | 无 | 无 |
| urlPrefix | Object | 可选 | 无 | 无 | 无 |
返回： 生成的图片 src.
开发
想要贡献代码？Great!!!
zyb-utils 使用 rollup构建，至于为什么要用rollup而不是webpack大家可以自己去寻找答案. 想要增加一个util工具类，你需要做以下几步操作：
- 1、将你的脚本文件放在src/util目录下；
- 2、将你的脚本注册到顶层目录下的utils.json中，所有对外输出的脚本都要在这里注册！！！
- 3、执行一下 npm run build:entry，会自动重新生成src目录下的index.js，即入口文件；
- 4、执行 npm run build进行构建；
Todos
- 写测试用例
- 编写文档
License
MIT
Free Software, Hell Yeah!