@dusky/ts-def
v1.0.5
Published
typescript defines extension
Downloads
14
Maintainers
tigerkinReadme
项目作用
为typescript编程添加常用到的类型扩展和泛型工具。 该工程用于编写、测试、文档和发布功能。
如何使用
npm install -D @dusky/ts-def- 以下方式均可：
- 将
dist/index.d.ts文件放到ts项目工程中任意位置。- 在需要使用定义扩展的地方
import "@dusky/ds-def"。
项目结构
- docs 生成文档工程
- res API导图等资源
- src 源码...
- base 基础...
- adv 高级...
- candidates 候选暂存
- tests 测试用例合集
- dist 发布(index.d.ts)
api列表
基础扩展
Primitive 原生类型扩展
bool布尔类型别名time时间类型别名num数值类型别名char数值类型别名str字符串类型别名primitive原生类型nullish空值类型falsy否值类型empty内容空值类型
Type 常用类型扩展
IVec2二维向量、点接口IVec3三维向量、点接口IVec4四维向量、点接口Class类类型Constructor构造函数类型Decorator装饰器类型DecoratorFactory装饰器工厂类型DecoratorSwapper装饰包装器类型Dictionary字典对象类型IsAny判断目标类型是否为any类型IsNever判断目标类型是否为never类型IsUnion判断目标类型是否为联合类型JsonObjectJson对象类型NonEmpty保留目标类型中的内容非空类型NonEmptyArr保留目标类型中的内容非空数组类型NumberArray内置数值数组类型PromisedPromise返回的数据类型point点vec2二维向量、点vec3三维向量、点vec4四维向量、点
Function 函数工具扩展
Append为已知函数（从后）追加参数（列表）Handler（一般处理）函数类型Lambda箭头函数类型Listener（不关心返回值的）监听函数类型Prepend为已知函数（从前）追加参数（列表）Validator（返回布尔值的）校验函数类型
Array 数组工具扩展
Contains判断类型数组（元组）中是否含有指定类型Elem获得类型数组（元组）的元素类型Every判断目标数组类型内元素是否全部满足要求EveryEquals判断目标数组类型内元素是否全部是具体类型Fill填充一个数组类型Filter过滤数组类型中符合要求的所有类型Head获得类型数组（元组）的第一个类型Heads获得类型数组（元组）的前多个类型的元组Length获取类型数组或元组所含类型的数量None判断目标数组类型内元素是否不存在满足要求NotContains判断类型数组（元组）中是否不含指定类型Pop移除类型数组（元组）最后一个类型Push从尾部向类型数组（元组）加入一个或多个类型Reverse反转类型数组（元组）Shift移除类型数组（元组）第一个类型Some判断目标数组类型内元素是否存在满足要求Tail获得类型数组（元组）的最后一个类型Tails获得类型数组（元组）的后多个类型的元组Unshift从头部向类型数组（元组）加入一个或多个类型
String 字符串工具扩展
CutEnd从尾部截取目标字符类型指定长度CutStart从头部截取目标字符类型指定长度EndsWith判断字符串类型是否以指定的子串结尾Join将给定字符串数组连接为字符串Repeat重复字符串类型Replace替代字符串类型中的首个子串ReplaceAll替代字符串类型中的所有子串Revert反转字符串类型Split将给定字符串类型拆解为数组StartsWith判断字符串类型是否以指定的子串开头StringToNumber将数值型字符串类型转成数值类型SubString截取目标字符类型指定开始和结束下标的子串Trim剪裁给定字符串两侧部分（空格）TrimLeft剪裁给定字符串左侧部分（空格）TrimRight剪裁给定字符串右侧部分（空格）
高阶扩展
Entry 提取工具扩展
...
Mapping 映射工具扩展
...
Infer 推断工具扩展
...
Recurse 递归工具扩展
...
Set 集合类工具扩展
...
API全景图
查看文档
打开docs/index.html即可。
测试用例
测试用例在/tests的对应文件夹下。 测试用例无需运行，静态编译不报错即可。