type-tls 2.7.0 → 3.0.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2020 郭斌勇
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2020 郭斌勇
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,87 +1,87 @@
-[教程]: ./doc/教程.md
-[API接口文档]: ./doc/api/index.md
-
-[GitHub仓库]: https://github.com/GuoBinyong/type-tls
-[发行地址]: https://github.com/GuoBinyong/type-tls/releases
-[issues]: https://github.com/GuoBinyong/type-tls/issues
-
-[码云仓库]: https://gitee.com/guobinyong/type-tls
-
-
-
-> 目录
-
-- [1. 简介](#1-简介)
-- [2. 安装方式](#2-安装方式)
-  - [2.1. 方式1：通过 npm 安装](#21-方式1通过-npm-安装)
-  - [2.2. 方式3：通过`<script>`标签引入](#22-方式3通过script标签引入)
-- [3. 教程](#3-教程)
-- [4. API接口文档](#4-api接口文档)
-
-
-
-
-# 1. 简介
-在使用 TypeScript 封装库时，如果希望设计更智能的 TypeScript 类型推导，则往往需要大量的类型相关的操作，type-tls 就提供了常用的类型操作的工具，比如：获取数据的类型 或 类型名字、判断数据的类型、还有一些 Type 工具。
-
-**详情请看：**  
-- 主页：<https://github.com/GuoBinyong/type-tls>
-- [GitHub仓库][]
-- [码云仓库][]
-- [教程][]
-- [API接口文档][]
-
-
-**如果您在使用的过程中遇到了问题，或者有好的建议和想法，您都可以通过以下方式联系我，期待与您的交流：**
-- 给该仓库提交 [issues][]
-- 给我 Pull requests
-- 邮箱：<guobinyong@qq.com>
-- QQ：guobinyong@qq.com
-- 微信：keyanzhe
-
-
-
-
-
-# 2. 安装方式
-目前，安装方式有以下几种：
-
-
-## 2.1. 方式1：通过 npm 安装
-通过 npm （或 yarn、pnpm 等包管理器）安装
-```
-npm install type-tls
-```
-
-
-
-
-## 2.2. 方式3：通过`<script>`标签引入
-您可直接从项目的 [发行地址][] 中下载以 `.iife.js` 作为缀的文件，然后使用如下代码引用 和 使用 type-tls：
-
-
-1. 引用 type-tls
-   ```
-   <script src="path/to/package/type-tls.iife.js"></script>
-   ```
-   
-2. 使用全局的 `TypeTls`
-   ```
-   <script>
-   // 使用全局的 TypeTls
-   </script>
-   ```
-
-# 3. 教程
-详情跳转至[教程][]
-
-# 4. API接口文档
-详情跳转至[API接口文档][]
-
-
-
---------------------
-
-> 有您的支持，我会在开源的道路上，越走越远
-
+[教程]: ./doc/教程.md
+[API接口文档]: ./doc/api/index.md
+
+[GitHub仓库]: https://github.com/GuoBinyong/type-tls
+[发行地址]: https://github.com/GuoBinyong/type-tls/releases
+[issues]: https://github.com/GuoBinyong/type-tls/issues
+
+[码云仓库]: https://gitee.com/guobinyong/type-tls
+
+
+
+> 目录
+
+- [1. 简介](#1-简介)
+- [2. 安装方式](#2-安装方式)
+  - [2.1. 方式1：通过 npm 安装](#21-方式1通过-npm-安装)
+  - [2.2. 方式3：通过`<script>`标签引入](#22-方式3通过script标签引入)
+- [3. 教程](#3-教程)
+- [4. API接口文档](#4-api接口文档)
+
+
+
+
+# 1. 简介
+在使用 TypeScript 封装库时，如果希望设计更智能的 TypeScript 类型推导，则往往需要大量的类型相关的操作，type-tls 就提供了常用的类型操作的工具，比如：获取数据的类型 或 类型名字、判断数据的类型、还有一些 Type 工具。
+
+**详情请看：**  
+- 主页：<https://github.com/GuoBinyong/type-tls>
+- [GitHub仓库][]
+- [码云仓库][]
+- [教程][]
+- [API接口文档][]
+
+
+**如果您在使用的过程中遇到了问题，或者有好的建议和想法，您都可以通过以下方式联系我，期待与您的交流：**
+- 给该仓库提交 [issues][]
+- 给我 Pull requests
+- 邮箱：<guobinyong@qq.com>
+- QQ：guobinyong@qq.com
+- 微信：keyanzhe
+
+
+
+
+
+# 2. 安装方式
+目前，安装方式有以下几种：
+
+
+## 2.1. 方式1：通过 npm 安装
+通过 npm （或 yarn、pnpm 等包管理器）安装
+```
+npm install type-tls
+```
+
+
+
+
+## 2.2. 方式3：通过`<script>`标签引入
+您可直接从项目的 [发行地址][] 中下载以 `.iife.js` 作为缀的文件，然后使用如下代码引用 和 使用 type-tls：
+
+
+1. 引用 type-tls
+   ```
+   <script src="path/to/package/type-tls.iife.js"></script>
+   ```
+   
+2. 使用全局的 `TypeTls`
+   ```
+   <script>
+   // 使用全局的 TypeTls
+   </script>
+   ```
+
+# 3. 教程
+详情跳转至[教程][]
+
+# 4. API接口文档
+详情跳转至[API接口文档][]
+
+
+
+--------------------
+
+> 有您的支持，我会在开源的道路上，越走越远
+
 ![赞赏码](https://i.loli.net/2020/04/08/PGsAEqdJCin1oQL.jpg)

package/dist/async.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 获取 Promise 解决的类型的值
+ * @remarks
+ * 对于非 Promise 类型的值，返回原类型本身
+ */
+export type ResolveData<P> = P extends Promise<infer D> ? D : P;
+/**
+ * waitAsyncable 的返回值的类型
+ */
+export type WaitAsyncableReturn<Result, Return> = Return extends Promise<any> ? Return : (Result extends Promise<any> ? Promise<Return> : Return);
+/**
+ * waitAsyncable 的回调函数的类型
+ * @param result -  同步的结果
+ * @param rejected - 异步是否被拒绝
+ */
+export type WaitAsyncableCallback<Result, Return> = (result: ResolveData<Result> | undefined, rejected: boolean, error: any) => Return;
+/**
+ * 等待可异步的结果
+ *
+ * @remarks
+ * 当 asyncable 为同步值时，会同步调用 callback。
+ * 当 asyncable 为异步值时，会等待 asyncable 解决后再调用 callback。
+ *
+ * @param asyncable - 可异步的结果
+ * @param callback
+ * @returns
+ */
+export declare function waitAsyncable<Result, Return>(asyncable: Result, callback: WaitAsyncableCallback<Result, Return>): WaitAsyncableReturn<Result, Return>;

package/dist/base.d.ts

@@ -0,0 +1,261 @@
+/**
+ * 处理类型相关的工具
+ * @remarks
+ * type-tls 封装了与类型相关的工具，比如获取数据的类型 或 类型名字、判断数据的类型 等
+ *
+ * @packageDocumentation
+ */
+import { AnyFunction } from "./function";
+/**
+ * 判断目标是否是对象类型
+ *
+ * @remarks
+ * 仅通过 target instanceof Object 判断是不行的，因为 对于 Object.create(null) 创建的对象 通过 ` Object.create(null) instanceof Object ` 来判断 返回的是 false
+ * 即：通过 Object.create(null) 创建的对象是不被 instanceof  认为是继续于 Object 的
+ *
+ * typeof null 也返回 "object"
+ *
+ * @param target : any   目标对象
+ */
+export declare function isObject(target: any): boolean;
+/**
+ * typeof 的返回类型
+ */
+export type TypeOfReturnType = "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function";
+/**
+ * 宽松的类型
+ */
+export type LooseType = undefined | null | Function | "object";
+/**
+ * 宽松类型的字符串表示
+ */
+export type LooseTypeName = "undefined" | "null" | "Function" | "object" | string;
+/**
+ * 精确类型
+ *
+ * @remarks
+ * 在精准类型中认为 JavaScript 的原始类型（非对象类型） 与 其对应的 包装类型（类类型）是不同的类型，即：
+ * number 和  Number、string 和 String、boolean 和 Boolean 等 是不同的类型；
+ * 对于原始类型，返回的结果 会与 typeof 返回的结果一样；
+ * 但，对于 undefined 和 null 会返回其自身值（即 undefined 和 null）作为类型值
+ *
+ * 各种类型的值 与 该方法的返回值 的映射如下：
+ * ```
+ * undefined ：undefined
+ * null : null
+ * string : "string"
+ * number : "number"
+ * bigint : "bigint"
+ * boolean : "boolean"
+ * symbol : "symbol"
+ * function : Function
+ * 没有原型的对象(如：通过 `Object.create(null)` 创建的对象) : "object"
+ * 其它任何类型的实例  : 返回该实例的构造函数
+ * ```
+ */
+export type ExactType = LooseType | Exclude<TypeOfReturnType, "undefined" | "function" | "object">;
+/**
+ * 精确类型的字符串表示
+ *
+ * @remarks
+ * 在精准类型中认为 JavaScript 的原始类型（非对象类型） 与 其对应的 包装类型（类类型）是不同的类型，即：
+ * number 和  Number、string 和 String、boolean 和 Boolean 等 是不同的类型；
+ * 对于原始类型，返回的结果 会与 typeof 返回的结果一样；
+ * 但，对于 null 会返回 "null"
+ *
+ * 各种类型的值 与 该方法的返回值 的映射如下：
+ * ```
+ * undefined ："undefined"
+ * null : "null"
+ * function : "Function"
+ * string : "string"
+ * number : "number"
+ * bigint : "bigint"
+ * boolean : "boolean"
+ * symbol : "symbol"
+ * 没有原型的对象(如：通过 Object.create(null) 创建的对象) : "object"
+ * 其它任何类型的实例  : 返回该实例的构造函数的名字
+ * ```
+ */
+export type ExactTypeName = LooseTypeName | Exclude<TypeOfReturnType, "undefined" | "function" | "object">;
+/**
+ * 获取 inst 的宽松类型
+ *
+ * @remarks
+ * 注意：
+ * 本方法返回的结果如下：
+ * ```
+ * undefined ：undefined
+ * null ： null
+ * function : Function
+ * 没有原型的对象(如：通过 Object.create(null) 创建的对象) : "object"
+ * 其它任何类型的实例  : 返回该实例的构造函数  或 包装对象的构造函数
+ * ```
+ *
+ *
+ * @param inst
+ * @returns inst 的类型
+ */
+export declare function getTypeOf(inst: any): LooseType;
+/**
+ * 获取 类型的字符串表示
+ *
+ * @param t - 一个 ExactType 类型的值
+ * @return t 的字符串表示的类型
+ */
+export declare function getNameOfType(t: ExactType): ExactTypeName;
+/**
+ * 根据类型的名字获取其对应的类
+ * @param typeName - 类型的名字
+ */
+export declare function getTypeByName(typeName: string): Function | undefined;
+/**
+ * 获取 inst 的类型字符串
+ *
+ * @remarks
+ * 注意：
+ * 本方法返回的结果如下：
+ * undefined ："undefined"
+ * null ： "null"
+ * 没有原型的对象(如：通过 Object.create(null) 创建的对象) : "object"
+ * 其它任何类型的实例  : 返回该实例的构造函数  或 包装对象的构造函数 的函数名字
+ *
+ * @param inst
+ * @returns  inst 的类型字符串
+ */
+export declare function getTypeNameOf(inst: any): LooseTypeName;
+/**
+ * 获取 inst 的精确类型
+ * @param inst
+ * @returns inst 的类型
+ */
+export declare function getExactTypeOf(inst: any): ExactType;
+/**
+ * 获取 inst 的精确类型的字符串表示
+ * @param inst
+ * @returns  inst 的类型字符串
+ */
+export declare function getExactTypeNameOf(inst: any): ExactTypeName;
+/**
+ * 判断 data 是否是 基本类型
+ * @remarks
+ * 基本类型 是指 那些不是 对象类型的类型，即，除了 object 和 function  类型以外，其它的都是基本类型，null 也算怎是 基本类型
+ * @param data - 任意类型的值
+ */
+export declare function isBaseType(data: any): boolean;
+/**
+ * 判断 target 是否为 类数组对象
+ * @param target  -  目标
+ * @returns
+ */
+export declare function isArrayLike(target: any): boolean;
+/**
+ * 判断 目标 是否是可迭代的对象，即 实现了 可迭代协议
+ * @param target - 目标
+ */
+export declare function isIterable(target: any): boolean;
+/**
+ * 判断 目标 是否是迭代器，即 实现了 迭代器协议
+ * @param target - 目标
+ */
+export declare function isIterator(target: any): boolean;
+/**
+ * 将某个类型变为可选的类型
+ */
+export type Optional<T> = T | null | undefined;
+/**
+ * 可选的布尔类型
+ */
+export type OptionalBoolean = Optional<boolean>;
+/**
+ * 获取值类型为指定类型的所有 key
+ *
+ * @typeParam Target - 目标对象
+ * @typeParam Value - 要获取的key的对应值的类型
+ */
+export type KeyOfValue<Target, Value> = {
+    [K in keyof Target]: Target[K] extends Value ? K : never;
+}[keyof Target];
+/**
+ * 获取值类型不是指定类型的所有 key
+ *
+ * @typeParam Target - 目标对象
+ * @typeParam Value - 被排除的值的类型
+ */
+export type KeyOfNonValue<Target, Value> = {
+    [K in keyof Target]: Target[K] extends Value ? never : K;
+}[keyof Target];
+/**
+ * 获取值类型包含指定类型的所有 key
+ *
+ * @typeParam Target - 目标对象
+ * @typeParam Value - 要获取的key的对应值应包含的类型
+ */
+export type KeyOfContainsValue<Target, Value> = {
+    [K in keyof Target]: Value extends Target[K] ? K : never;
+}[keyof Target];
+/**
+ * 获取值类型不应包含指定类型的所有 key
+ *
+ * @typeParam Target - 目标对象
+ * @typeParam Value - 不应包含的值的类型
+ */
+export type KeyOfNonContainsValue<Target, Value> = {
+    [K in keyof Target]: Value extends Target[K] ? never : K;
+}[keyof Target];
+/**
+ * 从 T 中挑选出那些成员值为 Value 的类型的成员
+ */
+export type PickValue<Target, Value> = {
+    [P in KeyOfValue<Target, Value>]: Target[P];
+};
+/**
+ * 从 Target 中挑选出那些成员值不是 Value 的类型的成员
+ */
+export type PickNonValue<Target, Value> = {
+    [P in KeyOfNonValue<Target, Value>]: Target[P];
+};
+/**
+ * 从 Target 中挑选出那些成员值的类型包含 Value 类型的成员
+ */
+export type PickContainsValue<Target, Value> = {
+    [P in KeyOfContainsValue<Target, Value>]: Target[P];
+};
+/**
+ * 从 Target 中挑选出那些成员值的类型不包含 Value 类型的成员
+ */
+export type PickNonContainsValue<Target, Value> = {
+    [P in KeyOfNonContainsValue<Target, Value>]: Target[P];
+};
+/**
+ * 从 Target 中挑选出属性
+ */
+export type PickProperty<Target> = PickNonValue<Target, AnyFunction>;
+/**
+ * 从 Target 中挑选出方法
+ */
+export type PickMethod<Target> = PickValue<Target, AnyFunction>;
+/**
+ * 将 T 及其对象成员属性值都改为 Partial 类型
+ * @remarks
+ * 比 Partial 又深入的一层
+ */
+export type TwoLayerPartial<T> = {
+    [P in keyof T]?: Partial<T[P]>;
+};
+/**
+ * 可将源类型 SourType 中的 类型 MatchType 替换为 新的类型 NewType
+ */
+export type Replace<SourType, MatchType, NewType> = SourType extends MatchType ? NewType : SourType;
+/**
+ * 可将源类型 SourType 中的 undefined 替换为 新的类型 NewType
+ */
+export type ReplaceUndefined<SourType, NewType> = Replace<SourType, undefined, NewType>;
+/**
+ * 可将源类型 SourType 中的 null 替换为 新的类型 NewType
+ */
+export type ReplaceNull<SourType, NewType> = Replace<SourType, null, NewType>;
+/**
+ * 可将源类型 SourType 中的代表空的类型 void | undefined | null 替换为 新的类型 NewType
+ */
+export type ReplaceVoid<SourType, NewType> = Replace<SourType, void | undefined | null, NewType>;

package/dist/buffer.d.ts

@@ -0,0 +1 @@
+export type TypedArray = Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array | BigInt64Array | BigUint64Array | Float32Array | Float64Array;

package/dist/function.d.ts

@@ -0,0 +1,49 @@
+/**
+ * 判断 code 是否是有校的 js 标识符
+ * @param code - 标识符的字符串
+ */
+export declare function isIdentifier(code: string): boolean;
+/**
+ * 判断函数是否是箭头函数
+ * @param fun - 被判断的函数
+ */
+export declare function isArrowFunction(fun: Function): boolean;
+/**
+ * 判断函数是否是 async 异步函数
+ * @remarks
+ * 异步函数 不包含 异步生成器函数 AsyncGeneratorFunction
+ * @param fun - 被判断的函数
+ */
+export declare function isAsyncFunction(fun: Function): boolean;
+/**
+ * 判断函数是否是生成器函数
+ *
+ * @remarks
+ * 生成器函数 不包含 异步生成器函数 AsyncGeneratorFunction
+ * @param fun - 被判断的函数
+ */
+export declare function isGeneratorFunction(fun: Function): boolean;
+/**
+ * 判断函数是否是异步生成器函数
+ * @param fun - 被判断的函数
+ */
+export declare function isAsyncGeneratorFunction(fun: Function): boolean;
+/**
+ * 判断是否是匿名函数
+ *
+ * @remarks
+ * 判断函数在被定义时是否是通过匿名函数来定义的。
+ * 匿名函数是指声明函数时没有写名字的函数。
+ * 注意：即使是匿名函数，函数对象上的 name 属性也可能是有值的，因为 js解析器 会自动将 函数表达式函数变量的名字作为匿名函数的名字，如下：
+ * ```ts
+ * var funName = function(){};
+ * ```
+ * 其中的匿名函数对象的 name 属性的值会是 `funName`
+ *
+ * 如果 函数对象上的 name 属性的值为 `""`，函数一定是匿名函数。
+ */
+export declare function isAnonymousFunction(fun: Function): boolean;
+/**
+ * 表示任意的函数类型
+ */
+export type AnyFunction = (...args: any) => any;