0.0.7 • Published 1 year ago
@dusky/ts-common-for-tsrpc v0.0.7
#ts-common-for-tsrpc
重要说明
这是ts-common的tsrpc特供版本,原ts-common与tsrpc都有对原型的修改会冲突, 该版本修改了一些函数命名以求兼容($开头为修改位置)。
项目作用
为typescript编程添加常用到的工具函数。 该工程用于编写、测试、文档和发布功能。
如何使用
npm install -D @dusky/ts-common-for-tsrpcimport "@dusky/ts-common-for-tsrpc"
项目结构
- /docs/ 生成文档工程
- /res/ API导图等资源
- /src/ 源码...
- /src_candidates/ 候选暂存...
- /tests/ 测试用例合集
- /dist/ 发布(index.js,index.d.ts)
api列表
全局函数扩展
isArr判断目标是否为数组isBool判断目标是否为布尔值isEmpty判断目标是否为内容空值isFunc判断目标是否为函数isNullish判断目标是否为空值isNum判断目标是否为数值isObject判断目标是否为对象类型isPrimitive判断目标是否为原生类型isRGB判断目标是否为RGB颜色值isRGBA判断目标是否为RGBA颜色值isStr判断目标是否为字符串isEqual判断目标是否为内容上相等notEmpty判断目标是否非内容空值notEmptyArr判断目标是否为非空数组对象类型扩展
对象类
Object.enumKeys获得枚举对象的所有键名Object.enumValues获得枚举对象的所有取值Object.deepGet深度获取对象的属性值Object.clean清空对象的空值、空字符串的属性Object.clone浅克隆(复制)对象Object.deepClone深克隆(复制)对象Object.set为对象设置属性assign为对象(指定键)赋值assignExcept为对象(指定键以外)赋值数组类型扩展
数组类
Array.fill生成一个新的填充数组Array.nature生成一个自然数序列数组Array.flatten扁平化数组数组实例(返回类型非自身)
arr.head获取数组首元素arr.tail获取数组末元素arr.heads返回数组前多个元素所组成的数组arr.tails返回数组末多个元素所组成的数组arr.copy拷贝原素组并返回新数组arr.loopAt循环获取下标值arr.random从数组随机取得值arr.contains判断数组是否包含某(些)值arr.excludes判断数组是否不包含某(些)值arr.all判断数组是否全部为某(些)值arr.notAll判断数组是否不全部为某(些)值arr.containsInstance判断数组是否包含某(些)类型实例(之一)arr.allInstance判断数组是否全部是某(些)类型实例数组实例(返回自身)
arr.unique去除数组中的重复元素arr.clean去除数组中的空值和空字符串元素arr.insert为数组插入某(些)值arr.delete删除数组指定数量的元素arr.$remove移除数组中所有某(些)值arr.exchange交换数组指定下标值arr.pushUnique从头部加入某(些)值,数组含有的值不会重复添加arr.unshiftUnique从末尾加入某(些)值,数组含有的值不会重复添加arr.descBy按照数组内对象指定属性数值降序重排数组arr.shuffle数组洗牌arr.swingCut数组切牌数组实例(数值数组)
arr.$max获取数组内最大值arr.$min获取数组内最小值arr.asc数值升序重排数组arr.desc数值降序重排数组函数类型扩展
Function.sleep等待指定时间Function.invoke执行指定函数Function.invoking执行指定函数(Promise)Function.wait等待指定时间执行指定函数字符类型扩展
String.Length计算字符串实际长度(中文为2,英文和数字符号为1)String.ellipsis截取字符串并补充省略号到指定长度String.uuid生成一个随机UUIDString.random(在指定范围内)生成随机字符串String.reverse反转字符串String.isChinese判断目标是否为纯中文字符串String.isLetters判断目标是否为纯英文字母String.isNumeric判断目标是否为纯数值字符串集合工具扩展
Array.merge求合集(不去重)Array.union求并集(去重)Array.intersection求交集(不去重)Array.subtraction求差集(不去重)Array.symComplement求对称补集(不去重)数学工具扩展
Math.randomRange在指定范围内随机数Math.randomInt在指定范围内随机整数Math.randomBool(按指定比例)随机布尔值Math.parseDegree弧度转角度Math.parseRadian角度转弧度Math.sum求算数和Math.sumSqr求平方和Math.avg求算数平均数Math.percentage求百分比整数(0-100)Math.lerp在两个数值间按比例插值Math.clamp在范围内截断数值Math.clamp01在0-1内截断数值Math.fixed保留n位小数数字工具扩展
Number.fix保留指定位小数Number.precise保留指定有效位API全景图
...
查看文档
打开docs/index.html即可。
测试用例
测试用例在/tests的对应文件夹下。 运行命令:
npm run test