type-tls 2.2.1 → 2.3.0

package/doc/type-tls.definemixin.md

@@ -0,0 +1,31 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [defineMixin](./type-tls.definemixin.md)
+
+## defineMixin() function
+
+定义混合的类型便利函数
+
+<b>Signature:</b>
+
+```typescript
+export declare function defineMixin<T, M>(target: T, mixin: M & ThisType<T & M>): M & ThisType<T & M>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  target | T | 混合的目标，用作 this 的类型 |
+|  mixin | M &amp; ThisType&lt;T &amp; M&gt; | 混合对象，会自动更改其this的类型 |
+
+<b>Returns:</b>
+
+M &amp; ThisType&lt;T &amp; M&gt;
+
+返回注入了 this 类型的 mixin 对象本身
+
+## Remarks
+
+它会更改 mixin 中方法的this指向为 target &amp; mixin，不会真的执行混合操作
+

package/doc/type-tls.extendtarget.md

@@ -0,0 +1,31 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [extendTarget](./type-tls.extendtarget.md)
+
+## extendTarget() function
+
+扩展目标
+
+<b>Signature:</b>
+
+```typescript
+export declare function extendTarget<C extends ClassType, E>(cla: C, ext: E & ThisType<InstanceType<C> & E>): ClassType<ConstructorParameters<C>, E & ThisType<InstanceType<C> & E>>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  cla | C | 扩展的目标，也用作 this 的类型 |
+|  ext | E &amp; ThisType&lt;InstanceType&lt;C&gt; &amp; E&gt; | 扩展对象，会自动更改其this的类型 |
+
+<b>Returns:</b>
+
+[ClassType](./type-tls.classtype.md)<!-- -->&lt;ConstructorParameters&lt;C&gt;, E &amp; ThisType&lt;InstanceType&lt;C&gt; &amp; E&gt;&gt;
+
+返回扩展后的 cla 对象
+
+## Remarks
+
+会执行对 CEarth 类的扩展操作。 与 [targetExtend()](./type-tls.targetextend.md) 的区别仅仅是返回类型不一样。
+

package/doc/type-tls.isanonymousfunction.md

@@ -0,0 +1,35 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [isAnonymousFunction](./type-tls.isanonymousfunction.md)
+
+## isAnonymousFunction() function
+
+判断是否是匿名函数
+
+<b>Signature:</b>
+
+```typescript
+export declare function isAnonymousFunction(fun: Function): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  fun | Function |  |
+
+<b>Returns:</b>
+
+boolean
+
+## Remarks
+
+判断函数在被定义时是否是通过匿名函数来定义的。 匿名函数是指声明函数时没有写名字的函数。 注意：即使是匿名函数，函数对象上的 name 属性也可能是有值的，因为 js解析器 会自动将 函数表达式函数变量的名字作为匿名函数的名字，如下：
+
+```ts
+var funName = function(){};
+```
+其中的匿名函数对象的 name 属性的值会是 `funName`
+
+如果 函数对象上的 name 属性的值为 `""`<!-- -->，函数一定是匿名函数。
+

package/doc/type-tls.isarrowfunction.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [isArrowFunction](./type-tls.isarrowfunction.md)
+
+## isArrowFunction() function
+
+判断函数是否是箭头函数
+
+<b>Signature:</b>
+
+```typescript
+export declare function isArrowFunction(fun: Function): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  fun | Function | 被判断的函数 |
+
+<b>Returns:</b>
+
+boolean
+

package/doc/type-tls.isasyncfunction.md

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [isAsyncFunction](./type-tls.isasyncfunction.md)
+
+## isAsyncFunction() function
+
+判断函数是否是 async 异步函数
+
+<b>Signature:</b>
+
+```typescript
+export declare function isAsyncFunction(fun: Function): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  fun | Function | 被判断的函数 |
+
+<b>Returns:</b>
+
+boolean
+
+## Remarks
+
+异步函数 不包含 异步生成器函数 AsyncGeneratorFunction
+

package/doc/type-tls.isasyncgeneratorfunction.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [isAsyncGeneratorFunction](./type-tls.isasyncgeneratorfunction.md)
+
+## isAsyncGeneratorFunction() function
+
+判断函数是否是异步生成器函数
+
+<b>Signature:</b>
+
+```typescript
+export declare function isAsyncGeneratorFunction(fun: Function): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  fun | Function | 被判断的函数 |
+
+<b>Returns:</b>
+
+boolean
+

package/doc/type-tls.isgeneratorfunction.md

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [isGeneratorFunction](./type-tls.isgeneratorfunction.md)
+
+## isGeneratorFunction() function
+
+判断函数是否是生成器函数
+
+<b>Signature:</b>
+
+```typescript
+export declare function isGeneratorFunction(fun: Function): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  fun | Function | 被判断的函数 |
+
+<b>Returns:</b>
+
+boolean
+
+## Remarks
+
+生成器函数 不包含 异步生成器函数 AsyncGeneratorFunction
+

package/doc/type-tls.isidentifier.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [isIdentifier](./type-tls.isidentifier.md)
+
+## isIdentifier() function
+
+判断 code 是否是有校的 js 标识符
+
+<b>Signature:</b>
+
+```typescript
+export declare function isIdentifier(code: string): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  code | string | 标识符的字符串 |
+
+<b>Returns:</b>
+
+boolean
+

package/doc/type-tls.md

@@ -4,36 +4,57 @@
 
 ## type-tls package
 
-处理类型相关的工具
-
-## Remarks
-
-type-tls 封装了与类型相关的工具，比如获取数据的类型 或 类型名字、判断数据的类型 等
-
 ## Functions
 
 |  Function | Description |
 |  --- | --- |
+|  [createDefineMixin()](./type-tls.createdefinemixin.md) | 创建定义混合的类型便利函数 |
+|  [createExtendTarget(cla)](./type-tls.createextendtarget.md) | 创建用于扩展目标工具函数 |
+|  [createMixinTarget(target)](./type-tls.createmixintarget.md) | 创建用于混合目标工具函数 |
+|  [createTargetExtend(cla)](./type-tls.createtargetextend.md) | 创建用于扩展目标的便捷函数 |
+|  [createTargetMixin(target)](./type-tls.createtargetmixin.md) | 创建用于混合目标的便捷函数 |
+|  [defineExtend(cla, ext)](./type-tls.defineextend.md) | 定义扩展的类型便利函数 |
+|  [defineMixin(target, mixin)](./type-tls.definemixin.md) | 定义混合的类型便利函数 |
+|  [extendTarget(cla, ext)](./type-tls.extendtarget.md) | 扩展目标 |
 |  [getExactTypeNameOf(inst)](./type-tls.getexacttypenameof.md) | 获取 inst 的精确类型的字符串表示 |
 |  [getExactTypeOf(inst)](./type-tls.getexacttypeof.md) | 获取 inst 的精确类型 |
 |  [getNameOfType(t)](./type-tls.getnameoftype.md) | 获取 类型的字符串表示 |
 |  [getTypeByName(typeName)](./type-tls.gettypebyname.md) | 根据类型的名字获取其对应的类 |
 |  [getTypeNameOf(inst)](./type-tls.gettypenameof.md) | 获取 inst 的类型字符串 |
 |  [getTypeOf(inst)](./type-tls.gettypeof.md) | 获取 inst 的宽松类型 |
+|  [isAnonymousFunction(fun)](./type-tls.isanonymousfunction.md) | 判断是否是匿名函数 |
 |  [isArrayLike(target)](./type-tls.isarraylike.md) | 判断 target 是否为 类数组对象 |
+|  [isArrowFunction(fun)](./type-tls.isarrowfunction.md) | 判断函数是否是箭头函数 |
+|  [isAsyncFunction(fun)](./type-tls.isasyncfunction.md) | 判断函数是否是 async 异步函数 |
+|  [isAsyncGeneratorFunction(fun)](./type-tls.isasyncgeneratorfunction.md) | 判断函数是否是异步生成器函数 |
 |  [isBaseType(data)](./type-tls.isbasetype.md) | 判断 data 是否是 基本类型 |
+|  [isGeneratorFunction(fun)](./type-tls.isgeneratorfunction.md) | 判断函数是否是生成器函数 |
+|  [isIdentifier(code)](./type-tls.isidentifier.md) | 判断 code 是否是有校的 js 标识符 |
 |  [isIterable(target)](./type-tls.isiterable.md) | 判断 目标 是否是可迭代的对象，即 实现了 可迭代协议 |
 |  [isIterator(target)](./type-tls.isiterator.md) | 判断 目标 是否是迭代器，即 实现了 迭代器协议 |
 |  [isObject(target)](./type-tls.isobject.md) | 判断目标是否是对象类型 |
+|  [mixin(target, sources)](./type-tls.mixin_4.md) | 混合 |
+|  [mixinTarget(target, m)](./type-tls.mixintarget.md) | 混合目标 |
+|  [targetExtend(cla, ext)](./type-tls.targetextend.md) | 扩展目标 |
+|  [targetMixin(target, m)](./type-tls.targetmixin.md) | 混合目标 |
+
+## Interfaces
+
+|  Interface | Description |
+|  --- | --- |
+|  [ClassType](./type-tls.classtype.md) | 类的类型、构造函数的类型 |
 
 ## Type Aliases
 
 |  Type Alias | Description |
 |  --- | --- |
+|  [AnyFunction](./type-tls.anyfunction.md) | 表示任意的函数类型 |
 |  [ExactType](./type-tls.exacttype.md) | 精确类型 |
 |  [ExactTypeName](./type-tls.exacttypename.md) | 精确类型的字符串表示 |
 |  [LooseType](./type-tls.loosetype.md) | 宽松的类型 |
 |  [LooseTypeName](./type-tls.loosetypename.md) | 宽松类型的字符串表示 |
+|  [MethodParams](./type-tls.methodparams.md) | 获取对象的方法的某个参数的类型 |
+|  [MethodReturnType](./type-tls.methodreturntype.md) | 获取对象的方法的返回的类型 |
 |  [Optional](./type-tls.optional.md) | 将某个类型变为可选的类型 |
 |  [OptionalBoolean](./type-tls.optionalboolean.md) | 可选的布尔类型 |
 |  [Replace](./type-tls.replace.md) | 可将源类型 SourType 中的 类型 MatchType 替换为 新的类型 NewType |

package/doc/type-tls.methodparams.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [MethodParams](./type-tls.methodparams.md)
+
+## MethodParams type
+
+获取对象的方法的某个参数的类型
+
+<b>Signature:</b>
+
+```typescript
+export declare type MethodParams<Obj, Method extends keyof Obj, ParamIndex extends number> = Obj[Method] extends AnyFunction ? Parameters<Obj[Method]>[ParamIndex] : never;
+```
+<b>References:</b> [AnyFunction](./type-tls.anyfunction.md)
+

package/doc/type-tls.methodreturntype.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [MethodReturnType](./type-tls.methodreturntype.md)
+
+## MethodReturnType type
+
+获取对象的方法的返回的类型
+
+<b>Signature:</b>
+
+```typescript
+export declare type MethodReturnType<Obj, Method extends keyof Obj> = Obj[Method] extends AnyFunction ? ReturnType<Obj[Method]> : never;
+```
+<b>References:</b> [AnyFunction](./type-tls.anyfunction.md)
+

package/doc/type-tls.mixin_4.md

@@ -0,0 +1,33 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [mixin](./type-tls.mixin_4.md)
+
+## mixin() function
+
+混合
+
+<b>Signature:</b>
+
+```typescript
+export declare function mixin(target: any, ...sources: any[]): any;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  target | any | 目标对象，所有 源对象 的属性都要被混入进到 目标对象中 |
+|  sources | any\[\] | 源对象，所有 源对象 的属性都要被混入进到 目标对象中 |
+
+<b>Returns:</b>
+
+any
+
+混入后的 target
+
+## Remarks
+
+将 source 的所有成员混入 target 对象中。
+
+与 `Object.assign()` 的功能类似，不同的是 `mixin()` 会在 target 对象中 保持 source 对象属性的 PropertyDescriptors
+

package/doc/type-tls.mixintarget.md

@@ -0,0 +1,31 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [mixinTarget](./type-tls.mixintarget.md)
+
+## mixinTarget() function
+
+混合目标
+
+<b>Signature:</b>
+
+```typescript
+export declare function mixinTarget<T, M>(target: T, m: M & ThisType<T & M>): M & ThisType<T & M> & T;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  target | T | 混合的目标，用作 this 的类型 |
+|  m | M &amp; ThisType&lt;T &amp; M&gt; | 混合对象，会自动更改其this的类型 |
+
+<b>Returns:</b>
+
+M &amp; ThisType&lt;T &amp; M&gt; &amp; T
+
+返回混合后的 target 对象
+
+## Remarks
+
+会执行对 CEarth 类的扩展操作。 与 [targetMixin()](./type-tls.targetmixin.md) 的区别仅仅是返回类型不一样。
+

package/doc/type-tls.targetextend.md

@@ -0,0 +1,31 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [targetExtend](./type-tls.targetextend.md)
+
+## targetExtend() function
+
+扩展目标
+
+<b>Signature:</b>
+
+```typescript
+export declare function targetExtend<C extends ClassType, E>(cla: C, ext: E & ThisType<InstanceType<C> & E>): E & ThisType<InstanceType<C> & E>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  cla | C | 扩展的目标，也用作 this 的类型 |
+|  ext | E &amp; ThisType&lt;InstanceType&lt;C&gt; &amp; E&gt; | 扩展描述对象，会自动更改其this的类型 |
+
+<b>Returns:</b>
+
+E &amp; ThisType&lt;InstanceType&lt;C&gt; &amp; E&gt;
+
+返回注入了 this 类型的 ext 对象本身
+
+## Remarks
+
+与 [defineExtend()](./type-tls.defineextend.md) 的区别是：`targetExtend` 会执行对 cla 的扩展操作，而 [defineExtend()](./type-tls.defineextend.md) 不会
+

package/doc/type-tls.targetmixin.md

@@ -0,0 +1,31 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [targetMixin](./type-tls.targetmixin.md)
+
+## targetMixin() function
+
+混合目标
+
+<b>Signature:</b>
+
+```typescript
+export declare function targetMixin<T, M>(target: T, m: M & ThisType<T & M>): M & ThisType<T & M>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  target | T | 混合的目标，用作 this 的类型 |
+|  m | M &amp; ThisType&lt;T &amp; M&gt; | 混合对象，会自动更改其this的类型 |
+
+<b>Returns:</b>
+
+M &amp; ThisType&lt;T &amp; M&gt;
+
+返回注入了 this 类型的 mixin 对象本身
+
+## Remarks
+
+与 [defineMixin()](./type-tls.definemixin.md) 的区别是：`targetMixin` 会执行对 target 的混合操作，而 [defineMixin()](./type-tls.definemixin.md) 不会
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "type-tls",
-  "version": "2.2.1",
+  "version": "2.3.0",
   "description": "type-tls 封装了与类型相关的工具，比如:获取数据的类型 或 类型名字、判断数据的类型 等",
   "main": "dist/type-tls.umd.js",
   "module": "dist/type-tls.es.js",
@@ -35,8 +35,8 @@
   ],
   "scripts": {
     "dev": "vite",
-    "build": "vite build && tsc  --emitDeclarationOnly",
-    "stage": "vite build --mode stage && tsc  --emitDeclarationOnly",
+    "build": "vite build",
+    "bunch": "vite build --mode bunch",
     "preview": "vite preview",
     "api": "api-extractor run -c api-extractor.jsonc -l -v",
     "doc": "npm run api ; api-documenter markdown -i ./temp -o doc"
@@ -44,6 +44,8 @@
   "devDependencies": {
     "@microsoft/api-documenter": "^7.17.15",
     "@microsoft/api-extractor": "^7.24.1",
+    "build-tls": "^1.3.11",
+    "dts-bundle-generator": "^6.12.0",
     "package-tls": "^1.2.2",
     "typescript": "^4.5.4",
     "vite": "^2.9.9"