type-tls 2.1.0 → 2.3.0

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.optional.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [Optional](./type-tls.optional.md)
+
+## Optional type
+
+将某个类型变为可选的类型
+
+<b>Signature:</b>
+
+```typescript
+export declare type Optional<T> = T | null | undefined;
+```

package/doc/type-tls.optionalboolean.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; [OptionalBoolean](./type-tls.optionalboolean.md)
+
+## OptionalBoolean type
+
+可选的布尔类型
+
+<b>Signature:</b>
+
+```typescript
+export declare type OptionalBoolean = Optional<boolean>;
+```
+<b>References:</b> [Optional](./type-tls.optional.md)
+

package/doc/type-tls.replace.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [Replace](./type-tls.replace.md)
+
+## Replace type
+
+可将源类型 SourType 中的 类型 MatchType 替换为 新的类型 NewType
+
+<b>Signature:</b>
+
+```typescript
+export declare type Replace<SourType, MatchType, NewType> = SourType extends MatchType ? NewType : SourType;
+```

package/doc/type-tls.replacenull.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; [ReplaceNull](./type-tls.replacenull.md)
+
+## ReplaceNull type
+
+可将源类型 SourType 中的 null 替换为 新的类型 NewType
+
+<b>Signature:</b>
+
+```typescript
+export declare type ReplaceNull<SourType, NewType> = Replace<SourType, null, NewType>;
+```
+<b>References:</b> [Replace](./type-tls.replace.md)
+

package/doc/type-tls.replaceundefined.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; [ReplaceUndefined](./type-tls.replaceundefined.md)
+
+## ReplaceUndefined type
+
+可将源类型 SourType 中的 undefined 替换为 新的类型 NewType
+
+<b>Signature:</b>
+
+```typescript
+export declare type ReplaceUndefined<SourType, NewType> = Replace<SourType, undefined, NewType>;
+```
+<b>References:</b> [Replace](./type-tls.replace.md)
+

package/doc/type-tls.replacevoid.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; [ReplaceVoid](./type-tls.replacevoid.md)
+
+## ReplaceVoid type
+
+可将源类型 SourType 中的代表空的类型 void \| undefined \| null 替换为 新的类型 NewType
+
+<b>Signature:</b>
+
+```typescript
+export declare type ReplaceVoid<SourType, NewType> = Replace<SourType, void | undefined | null, NewType>;
+```
+<b>References:</b> [Replace](./type-tls.replace.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/doc/type-tls.typeofreturntype.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [type-tls](./type-tls.md) &gt; [TypeOfReturnType](./type-tls.typeofreturntype.md)
+
+## TypeOfReturnType type
+
+typeof 的返回类型
+
+<b>Signature:</b>
+
+```typescript
+export declare type TypeOfReturnType = "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function";
+```

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "type-tls",
-  "version": "2.1.0",
-  "description": "type-tls 封装了与类型相关的工具，比如获取数据的类型 或 类型名字、判断数据的类型 等",
-  "main": "dist/type-tls.cjs.js",
+  "version": "2.3.0",
+  "description": "type-tls 封装了与类型相关的工具，比如:获取数据的类型 或 类型名字、判断数据的类型 等",
+  "main": "dist/type-tls.umd.js",
   "module": "dist/type-tls.es.js",
   "types": "dist/index.d.ts",
   "sideEffects": false,
@@ -11,6 +11,10 @@
     "type": "git",
     "url": "https://github.com/GuoBinyong/type-tls"
   },
+  "bugs": {
+    "url": "https://github.com/GuoBinyong/type-tls/issues",
+    "email": "guobinyong@qq.com"
+  },
   "keywords": [
     "type",
     "typeof",
@@ -18,31 +22,32 @@
     "instanceof",
     "类型"
   ],
-  "author": "郭斌勇",
-  "license": "ISC",
+  "author": {
+    "name": "郭斌勇",
+    "email": "guobinyong@qq.com"
+  },
+  "license": "MIT",
   "files": [
     "dist/[^.]*",
-    "types/[^.]*"
+    "types/[^.]*",
+    "docs/[^.]*",
+    "doc/[^.]*"
   ],
   "scripts": {
-    "build": "rollup -c",
-    "dev": "rollup -c -w",
-    "test": "node test/test.ts",
-    "pretest": "npm run build"
+    "dev": "vite",
+    "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"
   },
   "devDependencies": {
-    "@rollup/plugin-commonjs": "^11.1.0",
-    "@rollup/plugin-node-resolve": "^7.1.3",
-    "@rollup/plugin-typescript": "^4.1.2",
-    "@typescript-eslint/eslint-plugin": "^3.0.0",
-    "@typescript-eslint/parser": "^3.0.0",
-    "eslint": "^7.0.0",
-    "package-tls": "^1.0.2",
-    "path": "^0.12.7",
-    "rollup": "^2.7.2",
-    "rollup-plugin-terser": "^6.1.0",
-    "ts-node": "^8.9.1",
-    "tslib": "^2.0.0",
-    "typescript": "^3.8.3"
+    "@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"
   }
 }

package/dist/type-tls.cjs.js

@@ -1,165 +0,0 @@
-
-/*
-type-tls	v2.1.0
-author: 郭斌勇
-license: ISC
-homepage: https://github.com/GuoBinyong/type-tls#readme
-repository: https://github.com/GuoBinyong/type-tls
-description: type-tls 封装了与类型相关的工具，比如获取数据的类型 或 类型名字、判断数据的类型 等
-*/
-
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-/**
- * 判断目标是否是对象类型
- * @param target : any   目标对象
- *
- * 仅通过 target instanceof Object 判断是不行的，因为 对于 Object.create(null) 创建的对象 通过 ` Object.create(null) instanceof Object ` 来判断 返回的是 false
- * 即：通过 Object.create(null) 创建的对象是不被 instanceof  认为是继续于 Object 的
- *
- * typeof null 也返回 "object"
- */
-function isObject(target) {
-    // return target instanceof Object || typeof target === "object"
-    var tarType = typeof target;
-    return target && (tarType === "object" || tarType === "function");
-}
-/**
- * 获取 inst 的宽松类型
- * @param inst : any
- * @returns LooseType    inst 的类型
- *
- *
- *
- * 注意：
- * 本方法返回的结果如下：
- * undefined ：undefined
- * null ： null
- * function : Function
- * 没有原型的对象(如：通过 Object.create(null) 创建的对象) : "object"
- * 其它任何类型的实例  : 返回该实例的构造函数  或 包装对象的构造函数
- *
- */
-function getTypeOf(inst) {
-    var typeInfo = inst;
-    if (inst != null) {
-        typeInfo = inst.constructor;
-        if (typeInfo == undefined) {
-            typeInfo = typeof inst;
-        }
-    }
-    return typeInfo;
-}
-/**
- * 获取 类型的字符串表示
- * @param t
- * @return ExactTypeName
- */
-function getNameOfType(t) {
-    switch (t) {
-        case undefined: return "undefined";
-        case null: return "null";
-    }
-    let tType = typeof t;
-    switch (tType) {
-        case "function": return t.name;
-        case "string": return t;
-        default: return tType;
-    }
-}
-/**
- * 根据类型的名字获取类型
- * @param typeName
- */
-function getTypeByName(typeName) {
-    return globalThis[typeName];
-}
-/**
- * 获取 inst 的类型字符串
- * @param inst : any
- * @returns string    inst 的类型字符串
- *
- *
- *
- * 注意：
- * 本方法返回的结果如下：
- * undefined ："undefined"
- * null ： "null"
- * 没有原型的对象(如：通过 Object.create(null) 创建的对象) : "object"
- * 其它任何类型的实例  : 返回该实例的构造函数  或 包装对象的构造函数 的函数名字
- *
- */
-function getTypeNameOf(inst) {
-    let t = getTypeOf(inst);
-    return getNameOfType(t);
-}
-/**
- * 获取 inst 的精确类型
- * @param inst : any
- * @returns ExactType    inst 的类型
- */
-function getExactTypeOf(inst) {
-    if (inst == null || isObject(inst)) {
-        return getTypeOf(inst);
-    }
-    return (typeof inst);
-}
-/**
- * 获取 inst 的精确类型的字符串表示
- * @param inst : any
- * @returns ExactTypeName    inst 的类型字符串
- */
-function getExactTypeNameOf(inst) {
-    var t = getExactTypeOf(inst);
-    return getNameOfType(t);
-}
-/**
- * 判断 data 是否是 基本类型
- * @param data
- *
- * 基本类型 是指 那些不是 对象类型的类型，即，除了 object 和 function  类型以外，其它的都是基本类型，null 也算怎是 基本类型
- */
-function isBaseType(data) {
-    var typeStr = typeof data;
-    return data == null || (typeStr !== "object" && typeStr !== "function");
-}
-/**
- * isArrayLike(target)
- * 判断 target 是否为 类数组对象
- * @param target : any    目标
- * @returns boolean
- */
-function isArrayLike(target) {
-    let length = target && target.length;
-    return Number.isInteger(target.length) && length >= 0;
-}
-/**
- * 判断 目标 是否是可迭代的对象，即 实现了 可迭代协议
- * @param target : any
- * @return {boolean}
- */
-function isIterable(target) {
-    return target && (typeof target[Symbol.iterator] === "function");
-}
-/**
- * 判断 目标 是否是迭代器，即 实现了 迭代器协议
- * @param target : any
- * @return {boolean}
- */
-function isIterator(target) {
-    return target && (typeof target.next === "function");
-}
-
-exports.getExactTypeNameOf = getExactTypeNameOf;
-exports.getExactTypeOf = getExactTypeOf;
-exports.getNameOfType = getNameOfType;
-exports.getTypeByName = getTypeByName;
-exports.getTypeNameOf = getTypeNameOf;
-exports.getTypeOf = getTypeOf;
-exports.isArrayLike = isArrayLike;
-exports.isBaseType = isBaseType;
-exports.isIterable = isIterable;
-exports.isIterator = isIterator;
-exports.isObject = isObject;