app-lib-utils v0.0.33

一、背景介绍

二、功能描述

三、注意事项

四、使用案列

五、todo列表

六、API

Functions

type(any) ⇒ string

数据类型判断

• 通过对象原型的toString方法进行判断具体的数据类型(包含引用类型)

Kind: global function
Returns: string - 数据类型的字符串

• example

stringToRegxp(regString) ⇒ regexp | undefined

正则字符串转换为正则

• 不是正确正则字符串 返回undefined

Kind: global function
Returns: regexp | undefined - 转换的正则或者undefined

• example

isPlainObject(obj) ⇒ boolean

是否为纯粹对象

• 通过顶层的Object创建的对象则为纯粹对象

Kind: global function
Returns: boolean - true-纯粹对象 false-非纯粹对象

• example

arrayToObject(arr, key) ⇒ object

数组转换为对象键值对的方式

• 快速将数组转换为指定key值的对象

Kind: global function
Returns: object - 返回的对象

• example

createObj(key, value, split) ⇒ object

创建深层次对象

• 嵌套属性key默认用'.'来间隔对象, [] 标识数组
• 不存在 自动创建对象或者数组

Kind: global function
Returns: object - 创建新对象

• example

get(obj, key, split) ⇒ any

深度获取对象或数组属性值

Kind: global function
Returns: any - key对应的value值

• example

set(object, key, val, split) ⇒ object | array

设置深层对象属性和值

Kind: global function
Returns: object | array - 设置后的对象

• example

push(object, key, val, split) ⇒ array

数组深度追加数据

• 内存引用 不会新创建

Kind: global function
Returns: array - 设置后的对象

del(object, key, val, split) ⇒ object | array

删除指定属性的值

• 内存引用 不会新创建

Kind: global function
Returns: object | array - 设置后的对象

camelToUnderline(camelStr) ⇒ string

驼峰转下划线

Kind: global function
Returns: string - 下划线字符串

underlineToCamel(underlineStr) ⇒ string

下划线转驼峰

Kind: global function
Returns: string - 驼峰字符串

camelToConst(camelStr) ⇒ string

驼峰转常量格式

Kind: global function
Returns: string - 常量字符串

firstCharToUpperCase(camelStr) ⇒ string

首字母大写

Kind: global function
Returns: string - 常量字符串

dictToObj(dicts, fn) ⇒ object

字典表格式化

• 根据后端存储的字典表,快速适配到前端的使用

Kind: global function
Returns: object - 对象数据

• example

const dict = [ 
 { id: '1', code: 'pageState', key: 'add', value: '添加' },
 { id: '2', code: 'pageState', key: 'edit', value: '编辑' },
 ...
];

• 转换后的数据

  {
   PAGE_STATE:{ // 主要用于前端页面的常量处理
         ADD:'add', // 作为前端常量使用
         add:{ id: '1', code: 'pageState', key: 'add', value: '添加' } // 根key值快速找该字典
         ...
     }
   pageState:[ // 主要用于下拉显示-根据不同的组件库采用不同的字段转换,
      { id: '1', code: 'pageState', key: 'add', value: '添加' },
      ...
   ]
  } 

urlToObject(url, config) ⇒ object

解析查询参数

• 采用 encodeURIComponent 和 decodeURIComponent 进行编码和解码处理

Kind: global function
Returns: object - 解析对象

• example

objectToUrl(urlObj, config) ⇒ string

对象转换url查询参数

• 目前支持一层 后续有需要进行扩展

Kind: global function
Returns: string - 生成URL地址

• exmaple

isEmptyObj(obj)

判断对象是否空对象

Kind: global function
Retun: boolean 是否为空对象 true-空对象 false-纯在键/值

arrayToTree(array, option) ⇒ array | object

数组转换为树

Kind: global function
Returns: array | object - 转换后的树形数据

toString(str, resourceRadix, targetRadix, isUpperCase) ⇒ string

指定进制转换为指定进制

• 主要用到js的两个方法
• parseInt(str,radix) 将字符串str按照radix进制编码方式转换为10进制返回
• Number.toString(radix) 将该数字的指定进制形式的字符串

Kind: global function
Returns: string - 转换后的字符串

fill(str, length, fillFlag, isFront) ⇒ string

指定长度字符串自动填充指定标识

• 多余则截取

Kind: global function
Returns: string - 返回的长度

randomChineseWord() ⇒

随机生成汉子

• Unicode编码是16进制数，其中汉字对应范围为4E00-9FA5，转换为10进制数就是19968-40869
• 最新uncode 到9FC6了-- 还有第二个板块(plaint)的汉字体 当前方式不是完全的准确

Kind: global function
Returns: string

subStringByte(str, length) ⇒

按照字节长度截取字符串

Kind: global function
Returns: string 截取后的字符串

isAsyncFunction(func) ⇒ boolean

判断一个方法是否为异步的方法

Kind: global function
Returns: boolean - 是否未异步方法

• • example

randomColor() ⇒ string

随机生成16进制的颜色值

• TODO 后续支持透明度和更优雅的代码

Kind: global function
Returns: string - 随机生成16进制颜色

opacityToHex(opacity, isAutoFill) ⇒ string

JS透明度转换16进制

• 透明度是0-1 颜色值是0到255 - 故将透明度* 255再转换为16进制即为颜色16进制表示的最后两位标识
• 当前与chrome的转换一致 即 四舍五入的方式 将透明度转换为16进制
• isAutoFiled 是否自动补全(两位标识) 默认是

Kind: global function
Returns: string - 十六进制字符串

hexToOpacity(opacityHexStr) ⇒ string

16进制的透明度转换为颜色

Kind: global function
Returns: string - 透明颜色

colorHexToGBA(colorStr, isAutoFill) ⇒ object

16进制的颜色转换为gba格式的对象

Kind: global function
Returns: object - {r:1~255,g:1~255,b:1~255,a:0~1};

colorGBAToHex(colorObj) ⇒ string

rgba颜色对象转换为16进制的颜色字符串

Kind: global function
Returns: string - 颜色转换后的值

• example

clone(data) ⇒

clone 深度克隆数据

Kind: global function
Returns: any 任意数据类型

copyText(text)

复制文本到剪切版本

Kind: global function

download(url, fileName)

批量下载文件文件

Kind: global function

completeString(string, totalSum, fillString) ⇒ string

填充字符串

Kind: global function
Returns: string - 补全后的字符创

completeNumber(totalSum, number, hex) ⇒ string

[ompleteNumber 自动补全

Kind: global function
Returns: string - 补充后字符串

example: completeNumber(11,6,16) // result is "00000b" 将11转换16进制自动补全6位。

encodingStr(string, totalSum, hex) ⇒ string

编码字符串

Kind: global function
Returns: string - 编码字符串

splitStr(str, number, replace) ⇒ type

字符串分割

Kind: global function
Returns: type - 返回值

getUUID(id, unSplit, spStr) ⇒ string

创建UUID

Kind: global function
Returns: string - 生成UUID

• example:

• description:

  1:UUID结构
    |位数|   8  |   4 |   4   |   4   |   16   |
    |意义| 日期时间时钟 |     识别码     | 随机数  |
  2：识别码 支持中文、英文,只有前8位生效,中文前两个汉字,英文前4个字母;默认8位随机数。

syncPromises(promisesFns, promiseFnParams, breakCallback) ⇒ promise

同步执行批量promise方法-可进行控制

• 支持普通方法和异步方法一起执行
• 支持执行满足某种条件时,中断执行
• 支持每个promise都支持默认静态参数传递
• 支持每个pormise都能获取上一个或n个执行结果

Kind: global function
Returns: promise - promise对象 某个promise方法异常 在使用await时 需要捕获异常按照正常promise使用 按照标准promise使用即可

• 参数详细说明

  参数	入参	返回
  promisesFns	每个方法包含三个入参。arg是promiseFnParams对应下标值;preResult是上一个函数结果,第一个函数为null;all是所有执行过函数的结果值	promise
  promiseFnParams	每个参数都会按照数组下表对应到每个promisesFn arg	any
  function	中断回调函数。每个异步函数执行完毕都会调用。{ isError, result, allResult, errorResult },isError:执行是否异常,result执行结果,allResult全部结果,errorResult:异常结果	执行返回true中断，false执行下一个,默认是true

• 同步执行的常用场景

• example-fns

  函数	描述
  const fn1 = (arg, preResult, all) =>new Promise(resolve => log(arg, preResult, all) && setTimeout(() => resolve(Fn1-promise-success), 1000));	成功promise
  const fn2 = (arg, preResult, all) =>new Promise((s,reject) => log(arg, preResult, all) && setTimeout(() => reject(Fn2-promise-error), 1000));	异常promise
  const fn3 = (arg, preResult, all) => log(arg, preResult, all) && Fn3-function-success;	成功function
  const fn4 = (arg, preResult, all) =>new Promise(resolve => log(arg, preResult, all) && setTimeout(() => resolve(Fn4-promise-success), 1000));	成功promise

• example

七、发布日志

• 2023-09-13 03-23-13-添加正则匹配方法

• 2023-08-20 08-08-43-添加注释

• 2023-08-09 09-00-08-添暂停函数

• 2023-08-04 08-45-03-添加同步执行promise

• 2023-08-04 08-42-33-添加同步执行promise

• 2023-08-04 08-40-49-添加同步执行promise