type-tls 2.6.0 → 3.0.0

package/doc/api/type-tls.axisname.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [AxisName](./type-tls.axisname.md)
-
-## AxisName type
-
-轴名
-
-<b>Signature:</b>
-
-```typescript
-export declare type AxisName = "x" | "y" | "z";
-```

package/doc/api/type-tls.classtype._new_.md

@@ -1,22 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [ClassType](./type-tls.classtype.md) &gt; [(new)](./type-tls.classtype._new_.md)
-
-## ClassType.(new)
-
-<b>Signature:</b>
-
-```typescript
-new (...args: Arg): Instance;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  args | Arg |  |
-
-<b>Returns:</b>
-
-Instance
-

package/doc/api/type-tls.classtype.md

@@ -1,20 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [ClassType](./type-tls.classtype.md)
-
-## ClassType interface
-
-类的类型、构造函数的类型
-
-<b>Signature:</b>
-
-```typescript
-export interface ClassType<Arg extends any[] = any[], Instance = any> 
-```
-
-## Methods
-
-|  Method | Description |
-|  --- | --- |
-|  [(new)(args)](./type-tls.classtype._new_.md) |  |
-

package/doc/api/type-tls.createdefinemixin.md

@@ -1,23 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [createDefineMixin](./type-tls.createdefinemixin.md)
-
-## createDefineMixin() function
-
-创建定义混合的类型便利函数
-
-<b>Signature:</b>
-
-```typescript
-export declare function createDefineMixin<T>(): <M>(target: T, mixin: M & ThisType<T & M>) => M & ThisType<T & M>;
-```
-<b>Returns:</b>
-
-&lt;M&gt;(target: T, mixin: M &amp; ThisType&lt;T &amp; M&gt;) =&gt; M &amp; ThisType&lt;T &amp; M&gt;
-
-可以用于 定义混合的 类型便利函数
-
-## Remarks
-
-它返回的便利函数的功能与 [defineMixin()](./type-tls.definemixin.md) 的功能一样，唯一区别是不再需要接收 target 参数了
-

package/doc/api/type-tls.createextendtarget.md

@@ -1,30 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [createExtendTarget](./type-tls.createextendtarget.md)
-
-## createExtendTarget() function
-
-创建用于扩展目标工具函数
-
-<b>Signature:</b>
-
-```typescript
-export declare function createExtendTarget<C extends ClassType>(cla: C): <E>(ext: E & ThisType<InstanceType<C> & E> & PrivateMemberOfExtend<C>) => ClassType<ConstructorParameters<C>, E & ThisType<InstanceType<C> & E>>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  cla | C | 扩展的目标，也用作 this 的类型 |
-
-<b>Returns:</b>
-
-&lt;E&gt;(ext: E &amp; ThisType&lt;InstanceType&lt;C&gt; &amp; E&gt; &amp; [PrivateMemberOfExtend](./type-tls.privatememberofextend.md)<!-- -->&lt;C&gt;) =&gt; [ClassType](./type-tls.classtype.md)<!-- -->&lt;ConstructorParameters&lt;C&gt;, E &amp; ThisType&lt;InstanceType&lt;C&gt; &amp; E&gt;&gt;
-
-可以用于 扩展目标 的便利函数
-
-## Remarks
-
-它返回的便利函数的功能与 [extendTarget()](./type-tls.extendtarget.md) 的功能一样，唯一区别是不再需要接收 cla 参数了
-

package/doc/api/type-tls.createmixintarget.md

@@ -1,30 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [createMixinTarget](./type-tls.createmixintarget.md)
-
-## createMixinTarget() function
-
-创建用于混合目标工具函数
-
-<b>Signature:</b>
-
-```typescript
-export declare function createMixinTarget<T>(target: T): <M>(m: M & ThisType<T & M>) => M & ThisType<T & M> & T;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  target | T |  |
-
-<b>Returns:</b>
-
-&lt;M&gt;(m: M &amp; ThisType&lt;T &amp; M&gt;) =&gt; M &amp; ThisType&lt;T &amp; M&gt; &amp; T
-
-可以用于 混合目标 的便利函数
-
-## Remarks
-
-它返回的便利函数的功能与 [mixinTarget()](./type-tls.mixintarget.md) 的功能一样，唯一区别是不再需要接收 target 参数了
-

package/doc/api/type-tls.createtargetextend.md

@@ -1,30 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [createTargetExtend](./type-tls.createtargetextend.md)
-
-## createTargetExtend() function
-
-创建用于扩展目标的便捷函数
-
-<b>Signature:</b>
-
-```typescript
-export declare function createTargetExtend<C extends ClassType>(cla: C): <E>(ext: E & ThisType<InstanceType<C> & E> & PrivateMemberOfExtend<C>) => E & ThisType<C & E>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  cla | C | 扩展的目标，也用作 this 的类型 |
-
-<b>Returns:</b>
-
-&lt;E&gt;(ext: E &amp; ThisType&lt;InstanceType&lt;C&gt; &amp; E&gt; &amp; [PrivateMemberOfExtend](./type-tls.privatememberofextend.md)<!-- -->&lt;C&gt;) =&gt; E &amp; ThisType&lt;C &amp; E&gt;
-
-可以用于 扩展目标 的便利函数
-
-## Remarks
-
-它返回的便利函数的功能与 [targetExtend()](./type-tls.targetextend.md) 的功能一样，唯一区别是不再需要接收 cla 参数了
-

package/doc/api/type-tls.createtargetmixin.md

@@ -1,30 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [createTargetMixin](./type-tls.createtargetmixin.md)
-
-## createTargetMixin() function
-
-创建用于混合目标的便捷函数
-
-<b>Signature:</b>
-
-```typescript
-export declare function createTargetMixin<T>(target: T): <M>(m: M & ThisType<T & M>) => M & ThisType<T & M>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  target | T | 混合的目标，用作 this 的类型 |
-
-<b>Returns:</b>
-
-&lt;M&gt;(m: M &amp; ThisType&lt;T &amp; M&gt;) =&gt; M &amp; ThisType&lt;T &amp; M&gt;
-
-可以用于 混合目标 的便利函数
-
-## Remarks
-
-它返回的便利函数的功能与 [targetMixin()](./type-tls.targetmixin.md) 的功能一样，唯一区别是不再需要接收 target 参数了
-

package/doc/api/type-tls.defineextend.md

@@ -1,35 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [defineExtend](./type-tls.defineextend.md)
-
-## defineExtend() function
-
-定义扩展的类型便利函数
-
-<b>Signature:</b>
-
-```typescript
-export declare function defineExtend<C extends ClassType, E>(cla: C, ext: E & ThisType<InstanceType<C> & E> & PrivateMemberOfExtend<C>): E & ThisType<C & E>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  cla | C | 扩展的目标，用作 this 的类型 |
-|  ext | E &amp; ThisType&lt;InstanceType&lt;C&gt; &amp; E&gt; &amp; [PrivateMemberOfExtend](./type-tls.privatememberofextend.md)<!-- -->&lt;C&gt; | 描述扩展内容的对象，会自动更改其this的类型 |
-
-<b>Returns:</b>
-
-E &amp; ThisType&lt;C &amp; E&gt;
-
-返回注入了 this 类型的 ext 对象本身
-
-## Remarks
-
-它会更改 ext 中方法的this指向为 cla &amp; ext，不会真的执行扩展操作。
-
-其中 ext.\_constructor 会被保存在 cla.\_constructors 属性中，它是一个数组。
-
-cla 需要在自己的构建函数中逐个调用 cla.\_constructors 中的函数
-

package/doc/api/type-tls.definemixin.md

@@ -1,31 +0,0 @@
-<!-- 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/api/type-tls.extendtarget.md

@@ -1,31 +0,0 @@
-<!-- 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> & PrivateMemberOfExtend<C>): 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; &amp; [PrivateMemberOfExtend](./type-tls.privatememberofextend.md)<!-- -->&lt;C&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/api/type-tls.ivector.md

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [IVector](./type-tls.ivector.md)
-
-## IVector type
-
-向量
-
-<b>Signature:</b>
-
-```typescript
-export declare type IVector = IVector2 | IVector3 | IVector4;
-```
-<b>References:</b> [IVector2](./type-tls.ivector2.md)<!-- -->, [IVector3](./type-tls.ivector3.md)<!-- -->, [IVector4](./type-tls.ivector4.md)
-

package/doc/api/type-tls.ivector2.md

@@ -1,21 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [IVector2](./type-tls.ivector2.md)
-
-## IVector2 interface
-
-二维向量
-
-<b>Signature:</b>
-
-```typescript
-export interface IVector2 
-```
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [x](./type-tls.ivector2.x.md) |  | number |  |
-|  [y](./type-tls.ivector2.y.md) |  | number |  |
-

package/doc/api/type-tls.ivector2.x.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [IVector2](./type-tls.ivector2.md) &gt; [x](./type-tls.ivector2.x.md)
-
-## IVector2.x property
-
-<b>Signature:</b>
-
-```typescript
-x: number;
-```

package/doc/api/type-tls.ivector2.y.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [IVector2](./type-tls.ivector2.md) &gt; [y](./type-tls.ivector2.y.md)
-
-## IVector2.y property
-
-<b>Signature:</b>
-
-```typescript
-y: number;
-```

package/doc/api/type-tls.ivector3.md

@@ -1,21 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [IVector3](./type-tls.ivector3.md)
-
-## IVector3 interface
-
-三维向量
-
-<b>Signature:</b>
-
-```typescript
-export interface IVector3 extends IVector2 
-```
-<b>Extends:</b> [IVector2](./type-tls.ivector2.md)
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [z](./type-tls.ivector3.z.md) |  | number |  |
-

package/doc/api/type-tls.ivector3.z.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [IVector3](./type-tls.ivector3.md) &gt; [z](./type-tls.ivector3.z.md)
-
-## IVector3.z property
-
-<b>Signature:</b>
-
-```typescript
-z: number;
-```

package/doc/api/type-tls.ivector4.md

@@ -1,21 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [IVector4](./type-tls.ivector4.md)
-
-## IVector4 interface
-
-四维向量
-
-<b>Signature:</b>
-
-```typescript
-export interface IVector4 extends IVector3 
-```
-<b>Extends:</b> [IVector3](./type-tls.ivector3.md)
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [w](./type-tls.ivector4.w.md) |  | number |  |
-

package/doc/api/type-tls.ivector4.w.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [IVector4](./type-tls.ivector4.md) &gt; [w](./type-tls.ivector4.w.md)
-
-## IVector4.w property
-
-<b>Signature:</b>
-
-```typescript
-w: number;
-```

package/doc/api/type-tls.mixin_4.md

@@ -1,33 +0,0 @@
-<!-- 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/api/type-tls.mixintarget.md

@@ -1,31 +0,0 @@
-<!-- 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/api/type-tls.privatememberofextend._constructor.md

@@ -1,22 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [PrivateMemberOfExtend](./type-tls.privatememberofextend.md) &gt; [\_constructor](./type-tls.privatememberofextend._constructor.md)
-
-## PrivateMemberOfExtend.\_constructor property
-
-扩展类中用于定义在创建实例时的初始化的方法
-
-<b>Signature:</b>
-
-```typescript
-_constructor?: (...args: (TargetType extends new (...args: infer A) => any ? A : never)) => void;
-```
-
-## Remarks
-
-该方法会在创建实例时自动执行，并将构建函数接收到的参数透传给方方法。
-
-注意： \_constructor 会被保存在 目标类中的 \_constructors 属性中，它是一个数组。
-
-目标类 需要在自己的构建函数中逐个调用 cla.\_constructors 中的函数
-

package/doc/api/type-tls.privatememberofextend.md

@@ -1,20 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [PrivateMemberOfExtend](./type-tls.privatememberofextend.md)
-
-## PrivateMemberOfExtend interface
-
-用于定义扩展选项中的私有成员
-
-<b>Signature:</b>
-
-```typescript
-export interface PrivateMemberOfExtend<TargetType extends new (...args: any) => any> 
-```
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [\_constructor?](./type-tls.privatememberofextend._constructor.md) |  | (...args: (TargetType extends new (...args: infer A) =&gt; any ? A : never)) =&gt; void | <i>(Optional)</i> 扩展类中用于定义在创建实例时的初始化的方法 |
-

package/doc/api/type-tls.targetextend.md

@@ -1,31 +0,0 @@
-<!-- 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> & PrivateMemberOfExtend<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; &amp; [PrivateMemberOfExtend](./type-tls.privatememberofextend.md)<!-- -->&lt;C&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/api/type-tls.targetmixin.md

@@ -1,31 +0,0 @@
-<!-- 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) 不会
-