ts-type 3.0.1 → 3.0.2

package/lib/helper/tuple.js

@@ -1,3 +1,10 @@
 "use strict";
+/**
+ * 元組類型工具
+ * Tuple Type Utilities
+ *
+ * 提供元組相關的類型操作工具
+ * Provides tuple-related type manipulation utilities
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=tuple.js.map

package/lib/helper/tuple.js.map

@@ -1 +1 @@
-{"version":3,"file":"tuple.js","sourceRoot":"","sources":["tuple.ts"],"names":[],"mappings":"","sourcesContent":["\n/**\n * get keys of tuple\n *\n * @example\n * ITSTupleKeys<[string, string, string]> = \"0\" | \"1\" | \"2\"\n * @see https://stackoverflow.com/questions/50374908/transform-union-type-to-intersection-type\n */\nexport type ITSTupleKeys<T extends any[]> = Exclude<keyof T, keyof []>\n"]}
+{"version":3,"file":"tuple.js","sourceRoot":"","sources":["tuple.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG","sourcesContent":["/**\n * 元組類型工具\n * Tuple Type Utilities\n * \n * 提供元組相關的類型操作工具\n * Provides tuple-related type manipulation utilities\n */\n\n/**\n * 取得元組的數字索引鍵\n * Get numeric index keys of a tuple\n * \n * 回傳元組的所有數字索引（不包括陣列方法如 length、push 等）\n * Returns all numeric indices of the tuple (excluding array methods like length, push, etc.)\n * \n * @example\n * type Keys = ITSTupleKeys<[string, string, string]>;\n * // type Keys = \"0\" | \"1\" | \"2\"\n * \n * @see https://stackoverflow.com/questions/50374908/transform-union-type-to-intersection-type\n */\nexport type ITSTupleKeys<T extends any[]> = Exclude<keyof T, keyof []>\n"]}

package/lib/helper/typeof.d.ts

@@ -1,5 +1,39 @@
 /**
+ * 類型推断工具
+ * Type Inference Utilities
+ *
+ * 提供迭代器和其他類型相關的工具類型
+ * Provides iterator and other type-related utility types
+ *
  * Created by user on 2019/6/11.
  */
+/**
+ * 迭代器類型
+ * Iterator type
+ *
+ * 處理 Iterator 或 IteratorResult 類型，保留其原始結構
+ * Handles Iterator or IteratorResult types, preserving their original structure
+ *
+ * @example
+ * type LazyIterator = ITSIteratorLazy<Iterator<string>>;
+ * // type LazyIterator = Iterator<string>
+ */
 export type ITSIteratorLazy<T extends Iterator<any> | IteratorResult<any>> = T extends IteratorResult<infer U> ? IteratorResult<U> : T extends Iterator<infer U> ? Iterator<U> : T;
+/**
+ * 取得迭代器的值類型
+ * Get the value type of an iterator
+ *
+ * 從 Iterator 或 IteratorResult 類型中提取值類型
+ * Extracts the value type from Iterator or IteratorResult types
+ *
+ * @see https://stackoverflow.com/questions/49285864/is-there-a-valueof-similar-to-keyof-in-typescript
+ *
+ * @example
+ * type IteratorValue = ITSTypeOfIterator<Iterator<string>>;
+ * // type IteratorValue = string
+ *
+ * @example
+ * type IteratorResultValue = ITSTypeOfIterator<IteratorResult<number>>;
+ * // type IteratorResultValue = number
+ */
 export type ITSTypeOfIterator<T extends ITSIteratorLazy<any>> = T extends Iterator<infer U> ? U : T extends IteratorResult<infer U> ? U : any;

package/lib/helper/typeof.js

@@ -1,5 +1,11 @@
 "use strict";
 /**
+ * 類型推断工具
+ * Type Inference Utilities
+ *
+ * 提供迭代器和其他類型相關的工具類型
+ * Provides iterator and other type-related utility types
+ *
  * Created by user on 2019/6/11.
  */
 Object.defineProperty(exports, "__esModule", { value: true });

package/lib/helper/typeof.js.map

@@ -1 +1 @@
-{"version":3,"file":"typeof.js","sourceRoot":"","sources":["typeof.ts"],"names":[],"mappings":";AAAA;;GAEG","sourcesContent":["/**\n * Created by user on 2019/6/11.\n */\n\n\nexport type ITSIteratorLazy<T extends Iterator<any> | IteratorResult<any>> =\n//\tT\n\tT extends IteratorResult<infer U> ? IteratorResult<U> :\n\t\tT extends Iterator<infer U> ? Iterator<U> :\n\t\t\tT\n\t;\n\nexport type ITSTypeOfIterator<T extends ITSIteratorLazy<any>> =\n\tT extends Iterator<infer U> ? U :\n\t\tT extends IteratorResult<infer U> ? U :\n\t\t\tany\n\t;\n"]}
+{"version":3,"file":"typeof.js","sourceRoot":"","sources":["typeof.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG","sourcesContent":["/**\n * 類型推断工具\n * Type Inference Utilities\n * \n * 提供迭代器和其他類型相關的工具類型\n * Provides iterator and other type-related utility types\n * \n * Created by user on 2019/6/11.\n */\n\n/**\n * 迭代器類型\n * Iterator type\n * \n * 處理 Iterator 或 IteratorResult 類型，保留其原始結構\n * Handles Iterator or IteratorResult types, preserving their original structure\n * \n * @example\n * type LazyIterator = ITSIteratorLazy<Iterator<string>>;\n * // type LazyIterator = Iterator<string>\n */\nexport type ITSIteratorLazy<T extends Iterator<any> | IteratorResult<any>> =\n\tT extends IteratorResult<infer U> ? IteratorResult<U> :\n\t\tT extends Iterator<infer U> ? Iterator<U> :\n\t\t\tT\n\t;\n\n/**\n * 取得迭代器的值類型\n * Get the value type of an iterator\n * \n * 從 Iterator 或 IteratorResult 類型中提取值類型\n * Extracts the value type from Iterator or IteratorResult types\n * \n * @see https://stackoverflow.com/questions/49285864/is-there-a-valueof-similar-to-keyof-in-typescript\n * \n * @example\n * type IteratorValue = ITSTypeOfIterator<Iterator<string>>;\n * // type IteratorValue = string\n * \n * @example\n * type IteratorResultValue = ITSTypeOfIterator<IteratorResult<number>>;\n * // type IteratorResultValue = number\n */\nexport type ITSTypeOfIterator<T extends ITSIteratorLazy<any>> =\n\tT extends Iterator<infer U> ? U :\n\t\tT extends IteratorResult<infer U> ? U :\n\t\t\tany\n\t;\n"]}

package/lib/helper.d.ts

@@ -1,9 +1,11 @@
 import { ITSArrayListMaybeReadonly } from './type/base';
 import { ITSAwaitedReturnType } from './helper/promise';
 /**
- * copy current function with Parameters and return to new value
+ * 複製當前函數的參數並返回新的值類型
+ * Copy current function with Parameters and return to new value
  *
- * not support overload
+ * 不支援函數重載
+ * Not support overload
  *
  * @example
  * declare function f(a: number): number
@@ -11,10 +13,25 @@ import { ITSAwaitedReturnType } from './helper/promise';
  * // c = (a: number) => string
  */
 export type ITSOverwriteReturnType<T extends (...args: any[]) => any, R extends unknown> = (...args: Parameters<T>) => R;
+/**
+ * 將函數包裝為返回 PromiseLike 的版本
+ * Wrap function to return PromiseLike version
+ */
 export type ITSWrapFunctionPromiseLike<T extends (...args: any[]) => any> = (...args: Parameters<T>) => PromiseLike<ITSAwaitedReturnType<T>>;
+/**
+ * 將函數包裝為返回 Promise 的版本
+ * Wrap function to return Promise version
+ */
 export type ITSWrapFunctionPromise<T extends (...args: any[]) => any> = (...args: Parameters<T>) => Promise<ITSAwaitedReturnType<T>>;
 /**
- * @deprecated
+ * 擴展類型檢查：從 T 中提取屬於 U 的部分
+ * Extend type check: extract parts of T that belong to U
+ *
+ * @deprecated 已棄用 / Deprecated
  */
 export type ITSExtendsOf<T, U> = Extract<T, U>;
+/**
+ * 取得陣列類型的數字索引鍵
+ * Get numeric index keys of array type
+ */
 export type ITSKeyOfArray<T extends ITSArrayListMaybeReadonly<any>> = Exclude<keyof T, symbol | string>;

package/lib/helper.js.map

@@ -1 +1 @@
-{"version":3,"file":"helper.js","sourceRoot":"","sources":["helper.ts"],"names":[],"mappings":"","sourcesContent":["import { ITSArrayListMaybeReadonly } from './type/base';\nimport { ITSAwaitedReturnType } from './helper/promise';\n\n\n\n/**\n * copy current function with Parameters and return to new value\n *\n * not support overload\n *\n * @example\n * declare function f(a: number): number\n * declare let c: ITSOverwriteReturnType<typeof f, string>;\n * // c = (a: number) => string\n */\nexport type ITSOverwriteReturnType<T extends (...args: any[]) => any, R extends unknown> =\n\t(...args: Parameters<T>) => R;\n\nexport type ITSWrapFunctionPromiseLike<T extends (...args: any[]) => any> =\n\t(...args: Parameters<T>) => PromiseLike<ITSAwaitedReturnType<T>>;\nexport type ITSWrapFunctionPromise<T extends (...args: any[]) => any> =\n\t(...args: Parameters<T>) => Promise<ITSAwaitedReturnType<T>>;\n\n/**\n * @deprecated\n */\nexport type ITSExtendsOf<T, U> = Extract<T, U>;\n\nexport type ITSKeyOfArray<T extends ITSArrayListMaybeReadonly<any>> = Exclude<keyof T, symbol | string>;\n"]}
+{"version":3,"file":"helper.js","sourceRoot":"","sources":["helper.ts"],"names":[],"mappings":"","sourcesContent":["import { ITSArrayListMaybeReadonly } from './type/base';\nimport { ITSAwaitedReturnType } from './helper/promise';\n\n\n\n/**\n * 複製當前函數的參數並返回新的值類型\n * Copy current function with Parameters and return to new value\n * \n * 不支援函數重載\n * Not support overload\n *\n * @example\n * declare function f(a: number): number\n * declare let c: ITSOverwriteReturnType<typeof f, string>;\n * // c = (a: number) => string\n */\nexport type ITSOverwriteReturnType<T extends (...args: any[]) => any, R extends unknown> =\n\t(...args: Parameters<T>) => R;\n\n/**\n * 將函數包裝為返回 PromiseLike 的版本\n * Wrap function to return PromiseLike version\n */\nexport type ITSWrapFunctionPromiseLike<T extends (...args: any[]) => any> =\n\t(...args: Parameters<T>) => PromiseLike<ITSAwaitedReturnType<T>>;\n/**\n * 將函數包裝為返回 Promise 的版本\n * Wrap function to return Promise version\n */\nexport type ITSWrapFunctionPromise<T extends (...args: any[]) => any> =\n\t(...args: Parameters<T>) => Promise<ITSAwaitedReturnType<T>>;\n\n/**\n * 擴展類型檢查：從 T 中提取屬於 U 的部分\n * Extend type check: extract parts of T that belong to U\n * \n * @deprecated 已棄用 / Deprecated\n */\nexport type ITSExtendsOf<T, U> = Extract<T, U>;\n\n/**\n * 取得陣列類型的數字索引鍵\n * Get numeric index keys of array type\n */\nexport type ITSKeyOfArray<T extends ITSArrayListMaybeReadonly<any>> = Exclude<keyof T, symbol | string>;\n"]}

package/lib/internal/filter.d.ts

@@ -1 +1,8 @@
+/**
+ * 內部過濾工具（內部使用）
+ * Internal Filter Utilities (Internal Use)
+ *
+ * 提供內部使用的過濾類型工具
+ * Provides internal filter type utilities
+ */
 export {};

package/lib/internal/filter.js

@@ -1,3 +1,10 @@
 "use strict";
+/**
+ * 內部過濾工具（內部使用）
+ * Internal Filter Utilities (Internal Use)
+ *
+ * 提供內部使用的過濾類型工具
+ * Provides internal filter type utilities
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=filter.js.map

package/lib/internal/filter.js.map

@@ -1 +1 @@
-{"version":3,"file":"filter.js","sourceRoot":"","sources":["filter.ts"],"names":[],"mappings":"","sourcesContent":["import { ITSExtract2 } from '../helper/filter';\n\ntype I_RecordOfMatchKey<M, T, K extends keyof M = keyof M> = {\n\t[P in K]: ITSExtract2<M[P], T, P>;\n};\n\ntype I_RecordOfMatchValue<M, T, K extends keyof M = keyof M> = {\n\t[P in K]: ITSExtract2<M[P], T>;\n};\n"]}
+{"version":3,"file":"filter.js","sourceRoot":"","sources":["filter.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG","sourcesContent":["/**\n * 內部過濾工具（內部使用）\n * Internal Filter Utilities (Internal Use)\n * \n * 提供內部使用的過濾類型工具\n * Provides internal filter type utilities\n */\n\nimport { ITSExtract2 } from '../helper/filter';\n\n/**\n * 根據匹配鍵過濾記錄（內部使用）\n * Filter record by matching keys (internal use)\n * \n * @internal\n */\ntype I_RecordOfMatchKey<M, T, K extends keyof M = keyof M> = {\n\t[P in K]: ITSExtract2<M[P], T, P>;\n};\n\n/**\n * 根據匹配值過濾記錄（內部使用）\n * Filter record by matching values (internal use)\n * \n * @internal\n */\ntype I_RecordOfMatchValue<M, T, K extends keyof M = keyof M> = {\n\t[P in K]: ITSExtract2<M[P], T>;\n};\n"]}

package/lib/internal/logic/string-literal.d.ts

@@ -1,8 +1,41 @@
 /**
- * detect if T is a union
+ * 內部字串字面量邏輯工具（內部使用）
+ * Internal String Literal Logic Utilities (Internal Use)
+ *
+ * 提供內部使用的字串字面量邏輯判斷工具
+ * Provides internal string literal logic detection utilities
+ */
+/**
+ * 檢測 T 是否為聯合類型（內部使用）
+ * Detect if T is a union type (internal use)
+ *
+ * @internal
+ *
+ * @example
+ * type Test1 = IsAUnion<'a' | 'b'>;
+ * // type Test1 = true
+ *
+ * @example
+ * type Test2 = IsAUnion<'a'>;
+ * // type Test2 = false
  */
 export type IsAUnion<T, Y = true, N = false, U = T> = U extends any ? ([T] extends [U] ? N : Y) : never;
 /**
- * detect if T is a single string literal
+ * 檢測 T 是否為單一字串字面量（內部使用）
+ * Detect if T is a single string literal (internal use)
+ *
+ * @internal
+ *
+ * @example
+ * type Test1 = IsASingleStringLiteral<'hello'>;
+ * // type Test1 = true
+ *
+ * @example
+ * type Test2 = IsASingleStringLiteral<'a' | 'b'>;
+ * // type Test2 = false
+ *
+ * @example
+ * type Test3 = IsASingleStringLiteral<string>;
+ * // type Test3 = false
  */
 export type IsASingleStringLiteral<T extends string, Y = true, N = false> = string extends T ? N : [T] extends [never] ? N : IsAUnion<T, N, Y>;

package/lib/internal/logic/string-literal.js

@@ -1,3 +1,10 @@
 "use strict";
+/**
+ * 內部字串字面量邏輯工具（內部使用）
+ * Internal String Literal Logic Utilities (Internal Use)
+ *
+ * 提供內部使用的字串字面量邏輯判斷工具
+ * Provides internal string literal logic detection utilities
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=string-literal.js.map

package/lib/internal/logic/string-literal.js.map

@@ -1 +1 @@
-{"version":3,"file":"string-literal.js","sourceRoot":"","sources":["string-literal.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * detect if T is a union\n */\nexport type IsAUnion<T, Y = true, N = false, U = T> = U extends any\n\t? ([T] extends [U] ? N : Y)\n\t: never;\n\n/**\n * detect if T is a single string literal\n */\nexport type IsASingleStringLiteral<\n\tT extends string,\n\tY = true,\n\tN = false\n\t> = string extends T ? N : [T] extends [never] ? N : IsAUnion<T, N, Y>;\n"]}
+{"version":3,"file":"string-literal.js","sourceRoot":"","sources":["string-literal.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG","sourcesContent":["/**\n * 內部字串字面量邏輯工具（內部使用）\n * Internal String Literal Logic Utilities (Internal Use)\n * \n * 提供內部使用的字串字面量邏輯判斷工具\n * Provides internal string literal logic detection utilities\n */\n\n/**\n * 檢測 T 是否為聯合類型（內部使用）\n * Detect if T is a union type (internal use)\n * \n * @internal\n * \n * @example\n * type Test1 = IsAUnion<'a' | 'b'>;\n * // type Test1 = true\n * \n * @example\n * type Test2 = IsAUnion<'a'>;\n * // type Test2 = false\n */\nexport type IsAUnion<T, Y = true, N = false, U = T> = U extends any\n\t? ([T] extends [U] ? N : Y)\n\t: never;\n\n/**\n * 檢測 T 是否為單一字串字面量（內部使用）\n * Detect if T is a single string literal (internal use)\n * \n * @internal\n * \n * @example\n * type Test1 = IsASingleStringLiteral<'hello'>;\n * // type Test1 = true\n * \n * @example\n * type Test2 = IsASingleStringLiteral<'a' | 'b'>;\n * // type Test2 = false\n * \n * @example\n * type Test3 = IsASingleStringLiteral<string>;\n * // type Test3 = false\n */\nexport type IsASingleStringLiteral<\n\tT extends string,\n\tY = true,\n\tN = false\n\t> = string extends T ? N : [T] extends [never] ? N : IsAUnion<T, N, Y>;\n"]}

package/lib/logic/any.d.ts

@@ -1,5 +1,38 @@
 /**
+ * Any 類型判斷工具
+ * Any Type Detection Utilities
+ *
+ * 提供檢測類型是否為 any 的工具
+ * Provides utilities for detecting if a type is any
+ *
  * @see https://stackoverflow.com/questions/49927523/disallow-call-with-any/49928360#49928360
  */
+/**
+ * 檢測類型是否為 any
+ * Detect if a type is any
+ *
+ * 利用 any 與任何類型交叉都會得到 any 的特性來檢測
+ * Uses the fact that any intersected with any type still results in any
+ *
+ * @example
+ * type Test1 = ITSLogicIsAny<any>;
+ * // type Test1 = true
+ *
+ * @example
+ * type Test2 = ITSLogicIsAny<string>;
+ * // type Test2 = false
+ */
 export type ITSLogicIsAny<T, Y = true, N = false> = 0 extends (1 & T) ? Y : N;
+/**
+ * 檢測類型是否不為 any
+ * Detect if a type is not any
+ *
+ * @example
+ * type Test1 = ITSLogicNotAny<any>;
+ * // type Test1 = false
+ *
+ * @example
+ * type Test2 = ITSLogicNotAny<string>;
+ * // type Test2 = true
+ */
 export type ITSLogicNotAny<T, Y = true, N = false> = ITSLogicIsAny<T, N, Y>;

package/lib/logic/any.js

@@ -1,3 +1,12 @@
 "use strict";
+/**
+ * Any 類型判斷工具
+ * Any Type Detection Utilities
+ *
+ * 提供檢測類型是否為 any 的工具
+ * Provides utilities for detecting if a type is any
+ *
+ * @see https://stackoverflow.com/questions/49927523/disallow-call-with-any/49928360#49928360
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=any.js.map

package/lib/logic/any.js.map

@@ -1 +1 @@
-{"version":3,"file":"any.js","sourceRoot":"","sources":["any.ts"],"names":[],"mappings":"","sourcesContent":["\n/**\n * @see https://stackoverflow.com/questions/49927523/disallow-call-with-any/49928360#49928360\n */\nexport type ITSLogicIsAny<T, Y = true, N = false> = 0 extends (1 & T) ? Y : N\n\nexport type ITSLogicNotAny<T, Y = true, N = false> = ITSLogicIsAny<T, N, Y>\n"]}
+{"version":3,"file":"any.js","sourceRoot":"","sources":["any.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG","sourcesContent":["/**\n * Any 類型判斷工具\n * Any Type Detection Utilities\n * \n * 提供檢測類型是否為 any 的工具\n * Provides utilities for detecting if a type is any\n * \n * @see https://stackoverflow.com/questions/49927523/disallow-call-with-any/49928360#49928360\n */\n\n/**\n * 檢測類型是否為 any\n * Detect if a type is any\n * \n * 利用 any 與任何類型交叉都會得到 any 的特性來檢測\n * Uses the fact that any intersected with any type still results in any\n * \n * @example\n * type Test1 = ITSLogicIsAny<any>;\n * // type Test1 = true\n * \n * @example\n * type Test2 = ITSLogicIsAny<string>;\n * // type Test2 = false\n */\nexport type ITSLogicIsAny<T, Y = true, N = false> = 0 extends (1 & T) ? Y : N\n\n/**\n * 檢測類型是否不為 any\n * Detect if a type is not any\n * \n * @example\n * type Test1 = ITSLogicNotAny<any>;\n * // type Test1 = false\n * \n * @example\n * type Test2 = ITSLogicNotAny<string>;\n * // type Test2 = true\n */\nexport type ITSLogicNotAny<T, Y = true, N = false> = ITSLogicIsAny<T, N, Y>\n"]}

package/lib/logic/never.d.ts

@@ -1 +1,23 @@
+/**
+ * Never 類型判斷工具
+ * Never Type Detection Utilities
+ *
+ * 提供檢測類型是否為 never 的工具
+ * Provides utilities for detecting if a type is never
+ */
+/**
+ * 檢測類型是否為 never
+ * Detect if a type is never
+ *
+ * 利用 never 是所有類型的子類型特性來檢測
+ * Uses the fact that never is a subtype of all types
+ *
+ * @example
+ * type Test1 = ITSLogicIsNever<never>;
+ * // type Test1 = true
+ *
+ * @example
+ * type Test2 = ITSLogicIsNever<string>;
+ * // type Test2 = false
+ */
 export type ITSLogicIsNever<T, Y = true, N = false> = [T] extends [never] ? Y : N;

package/lib/logic/never.js

@@ -1,3 +1,10 @@
 "use strict";
+/**
+ * Never 類型判斷工具
+ * Never Type Detection Utilities
+ *
+ * 提供檢測類型是否為 never 的工具
+ * Provides utilities for detecting if a type is never
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=never.js.map

package/lib/logic/never.js.map

@@ -1 +1 @@
-{"version":3,"file":"never.js","sourceRoot":"","sources":["never.ts"],"names":[],"mappings":"","sourcesContent":["\nexport type ITSLogicIsNever<T, Y = true, N = false> = [T] extends [never] ? Y : N\n"]}
+{"version":3,"file":"never.js","sourceRoot":"","sources":["never.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG","sourcesContent":["/**\n * Never 類型判斷工具\n * Never Type Detection Utilities\n * \n * 提供檢測類型是否為 never 的工具\n * Provides utilities for detecting if a type is never\n */\n\n/**\n * 檢測類型是否為 never\n * Detect if a type is never\n * \n * 利用 never 是所有類型的子類型特性來檢測\n * Uses the fact that never is a subtype of all types\n * \n * @example\n * type Test1 = ITSLogicIsNever<never>;\n * // type Test1 = true\n * \n * @example\n * type Test2 = ITSLogicIsNever<string>;\n * // type Test2 = false\n */\nexport type ITSLogicIsNever<T, Y = true, N = false> = [T] extends [never] ? Y : N\n"]}

package/lib/logic/union/index.d.ts

@@ -1,15 +1,41 @@
+/**
+ * 聯合類型邏輯工具
+ * Union Type Logic Utilities
+ *
+ * 提供聯合類型相關的邏輯判斷工具
+ * Provides union type-related logic detection utilities
+ */
 import { ITSUnionToIntersection } from '../../helper/intersection';
 import { ITSLogicIsNever } from '../never';
+/**
+ * 檢測類型是否為聯合類型
+ * Detect if a type is a union type
+ *
+ * @example
+ * type Test1 = ITSLogicIsUnion<string | number>;
+ * // type Test1 = true
+ *
+ * @example
+ * type Test2 = ITSLogicIsUnion<string>;
+ * // type Test2 = false
+ */
 export type ITSLogicIsUnion<T, Y = true, N = false> = [T] extends [ITSUnionToIntersection<T>] ? N : Y;
 /**
+ * 檢測類型是否為單一非聯合類型
+ * Detect if a type is a single non-union type
+ *
  * @see https://stackoverflow.com/a/49982981/4563339
+ *
  * @example
- * let a: ITSLogicIsSingleNonUnion01<'' | '4' | any, string>
- * let b: ITSLogicIsSingleNonUnion01<'' & '4' & any, string>
- * let c: ITSLogicIsSingleNonUnion01<'', string>
+ * type Test1 = ITSLogicIsSingleNonUnion01<'' | '4' | any, string>;
+ * // type Test1 = false (因為是聯合類型)
  *
- * expectType<false>(a);
- * expectType<false>(b);
- * expectType<true>(c);
+ * @example
+ * type Test2 = ITSLogicIsSingleNonUnion01<'' & '4' & any, string>;
+ * // type Test2 = false (因為是交集類型)
+ *
+ * @example
+ * type Test3 = ITSLogicIsSingleNonUnion01<'', string>;
+ * // type Test3 = true (因為是單一類型)
  */
 export type ITSLogicIsSingleNonUnion01<T, U extends any, Y = true, N = false> = U extends T ? N : ITSLogicIsNever<T, N, ITSLogicIsUnion<T, N, Y>>;

package/lib/logic/union/index.js

@@ -1,3 +1,10 @@
 "use strict";
+/**
+ * 聯合類型邏輯工具
+ * Union Type Logic Utilities
+ *
+ * 提供聯合類型相關的邏輯判斷工具
+ * Provides union type-related logic detection utilities
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=index.js.map

package/lib/logic/union/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"","sourcesContent":["import { ITSUnionToIntersection } from '../../helper/intersection';\nimport { ITSLogicIsNever } from '../never';\n\nexport type ITSLogicIsUnion<T, Y = true, N = false> = [T] extends [ITSUnionToIntersection<T>] ? N : Y\n\n/**\n * @see https://stackoverflow.com/a/49982981/4563339\n * @example\n * let a: ITSLogicIsSingleNonUnion01<'' | '4' | any, string>\n * let b: ITSLogicIsSingleNonUnion01<'' & '4' & any, string>\n * let c: ITSLogicIsSingleNonUnion01<'', string>\n *\n * expectType<false>(a);\n * expectType<false>(b);\n * expectType<true>(c);\n */\nexport type ITSLogicIsSingleNonUnion01<\n\tT,\n\tU extends any,\n\tY = true,\n\tN = false\n> = U extends T ?\n\tN : ITSLogicIsNever<T, N, ITSLogicIsUnion<T, N, Y>>\n\t;\n\n\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG","sourcesContent":["/**\n * 聯合類型邏輯工具\n * Union Type Logic Utilities\n * \n * 提供聯合類型相關的邏輯判斷工具\n * Provides union type-related logic detection utilities\n */\n\nimport { ITSUnionToIntersection } from '../../helper/intersection';\nimport { ITSLogicIsNever } from '../never';\n\n/**\n * 檢測類型是否為聯合類型\n * Detect if a type is a union type\n * \n * @example\n * type Test1 = ITSLogicIsUnion<string | number>;\n * // type Test1 = true\n * \n * @example\n * type Test2 = ITSLogicIsUnion<string>;\n * // type Test2 = false\n */\nexport type ITSLogicIsUnion<T, Y = true, N = false> = [T] extends [ITSUnionToIntersection<T>] ? N : Y\n\n/**\n * 檢測類型是否為單一非聯合類型\n * Detect if a type is a single non-union type\n * \n * @see https://stackoverflow.com/a/49982981/4563339\n * \n * @example\n * type Test1 = ITSLogicIsSingleNonUnion01<'' | '4' | any, string>;\n * // type Test1 = false (因為是聯合類型)\n * \n * @example\n * type Test2 = ITSLogicIsSingleNonUnion01<'' & '4' & any, string>;\n * // type Test2 = false (因為是交集類型)\n * \n * @example\n * type Test3 = ITSLogicIsSingleNonUnion01<'', string>;\n * // type Test3 = true (因為是單一類型)\n */\nexport type ITSLogicIsSingleNonUnion01<\n\tT,\n\tU extends any,\n\tY = true,\n\tN = false\n> = U extends T ?\n\tN : ITSLogicIsNever<T, N, ITSLogicIsUnion<T, N, Y>>\n\t;\n"]}

package/lib/type/base.d.ts

@@ -1,13 +1,89 @@
 /**
- * Created by user on 2019/5/17.
+ * 基礎類型定義
+ * Base Type Definitions
+ *
+ * 提供常用的基礎類型別名和工具類型
+ * Provides commonly used base type aliases and utility types
  */
 import { ITSTypeFunction } from '../generic';
+/**
+ * 陣列類型：可讀寫陣列或唯讀陣列
+ * Array type: writable array or readonly array
+ *
+ * @example
+ * type StringList = ITSArrayListMaybeReadonly<string>;
+ * // type StringList = string[] | readonly string[]
+ */
 export type ITSArrayListMaybeReadonly<T> = T[] | readonly T[];
+/**
+ * 鍵的類型：符號、字串或數字
+ * Key types: symbol, string, or number
+ *
+ * @example
+ * type Keys = ITSKeys;
+ * // type Keys = symbol | string | number
+ */
 export type ITSKeys = symbol | string | number;
+/**
+ * 建構函數類型
+ * Constructor type
+ *
+ * @example
+ * type MyConstructor = ITSConstructorLike<MyClass>;
+ * // type MyConstructor = new (...args: any) => MyClass
+ */
 export type ITSConstructorLike<T extends any = any> = new (...args: any) => T;
+/**
+ * 值或陣列：單一值或其陣列
+ * Value or array: single value or array of that value
+ *
+ * @example
+ * type StringOrArray = ITSValueOrArray<string>;
+ * // type StringOrArray = string | string[]
+ */
 export type ITSValueOrArray<T> = T | T[];
+/**
+ * 值或可能唯讀的陣列：單一值、可讀寫陣列或唯讀陣列
+ * Value or possibly readonly array: single value, writable array, or readonly array
+ *
+ * @example
+ * type StringOrList = ITSValueOrArrayMaybeReadonly<string>;
+ * // type StringOrList = string | string[] | readonly string[]
+ */
 export type ITSValueOrArrayMaybeReadonly<T> = T | ITSArrayListMaybeReadonly<T>;
+/**
+ * 屬性鍵類型：字串或符號
+ * Property key type: string or symbol
+ *
+ * @example
+ * type PropKey = ITSPropertyKey;
+ * // type PropKey = string | symbol
+ */
 export type ITSPropertyKey = string | symbol;
+/**
+ * 任意函數類型
+ * Any function type
+ *
+ * @example
+ * type AnyFunc = ITSAnyFunction;
+ * // type AnyFunc = (...args: any[]) => any
+ */
 export type ITSAnyFunction = ITSTypeFunction<any>;
+/**
+ * 基本原始類型：數字、字串或布林值
+ * Basic primitive types: number, string, or boolean
+ *
+ * @example
+ * type Primitive = ITSBasicPrimitive;
+ * // type Primitive = number | string | boolean
+ */
 export type ITSBasicPrimitive = number | string | boolean;
+/**
+ * 可為空的原始類型：null 或 undefined
+ * Nullable primitive types: null or undefined
+ *
+ * @example
+ * type Nullish = ITSNullPrimitive;
+ * // type Nullish = null | undefined
+ */
 export type ITSNullPrimitive = null | undefined;

package/lib/type/base.js

@@ -1,6 +1,10 @@
 "use strict";
 /**
- * Created by user on 2019/5/17.
+ * 基礎類型定義
+ * Base Type Definitions
+ *
+ * 提供常用的基礎類型別名和工具類型
+ * Provides commonly used base type aliases and utility types
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=base.js.map

package/lib/type/base.js.map

@@ -1 +1 @@
-{"version":3,"file":"base.js","sourceRoot":"","sources":["base.ts"],"names":[],"mappings":";AAAA;;GAEG","sourcesContent":["/**\n * Created by user on 2019/5/17.\n */\n\nimport { ITSTypeFunction } from '../generic';\n\nexport type ITSArrayListMaybeReadonly<T> = T[] | readonly T[];\n\nexport type ITSKeys = symbol | string | number;\n\nexport type ITSConstructorLike<T extends any = any> = new(...args: any) => T;\n\nexport type ITSValueOrArray<T> = T | T[];\n\nexport type ITSValueOrArrayMaybeReadonly<T> = T | ITSArrayListMaybeReadonly<T>;\n\nexport type ITSPropertyKey = string | symbol;\n\nexport type ITSAnyFunction = ITSTypeFunction<any>;\n\nexport type ITSBasicPrimitive = number | string | boolean;\n\nexport type ITSNullPrimitive = null | undefined;\n\n"]}
+{"version":3,"file":"base.js","sourceRoot":"","sources":["base.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG","sourcesContent":["/**\n * 基礎類型定義\n * Base Type Definitions\n * \n * 提供常用的基礎類型別名和工具類型\n * Provides commonly used base type aliases and utility types\n */\n\nimport { ITSTypeFunction } from '../generic';\n\n/**\n * 陣列類型：可讀寫陣列或唯讀陣列\n * Array type: writable array or readonly array\n * \n * @example\n * type StringList = ITSArrayListMaybeReadonly<string>;\n * // type StringList = string[] | readonly string[]\n */\nexport type ITSArrayListMaybeReadonly<T> = T[] | readonly T[];\n\n/**\n * 鍵的類型：符號、字串或數字\n * Key types: symbol, string, or number\n * \n * @example\n * type Keys = ITSKeys;\n * // type Keys = symbol | string | number\n */\nexport type ITSKeys = symbol | string | number;\n\n/**\n * 建構函數類型\n * Constructor type\n * \n * @example\n * type MyConstructor = ITSConstructorLike<MyClass>;\n * // type MyConstructor = new (...args: any) => MyClass\n */\nexport type ITSConstructorLike<T extends any = any> = new(...args: any) => T;\n\n/**\n * 值或陣列：單一值或其陣列\n * Value or array: single value or array of that value\n * \n * @example\n * type StringOrArray = ITSValueOrArray<string>;\n * // type StringOrArray = string | string[]\n */\nexport type ITSValueOrArray<T> = T | T[];\n\n/**\n * 值或可能唯讀的陣列：單一值、可讀寫陣列或唯讀陣列\n * Value or possibly readonly array: single value, writable array, or readonly array\n * \n * @example\n * type StringOrList = ITSValueOrArrayMaybeReadonly<string>;\n * // type StringOrList = string | string[] | readonly string[]\n */\nexport type ITSValueOrArrayMaybeReadonly<T> = T | ITSArrayListMaybeReadonly<T>;\n\n/**\n * 屬性鍵類型：字串或符號\n * Property key type: string or symbol\n * \n * @example\n * type PropKey = ITSPropertyKey;\n * // type PropKey = string | symbol\n */\nexport type ITSPropertyKey = string | symbol;\n\n/**\n * 任意函數類型\n * Any function type\n * \n * @example\n * type AnyFunc = ITSAnyFunction;\n * // type AnyFunc = (...args: any[]) => any\n */\nexport type ITSAnyFunction = ITSTypeFunction<any>;\n\n/**\n * 基本原始類型：數字、字串或布林值\n * Basic primitive types: number, string, or boolean\n * \n * @example\n * type Primitive = ITSBasicPrimitive;\n * // type Primitive = number | string | boolean\n */\nexport type ITSBasicPrimitive = number | string | boolean;\n\n/**\n * 可為空的原始類型：null 或 undefined\n * Nullable primitive types: null or undefined\n * \n * @example\n * type Nullish = ITSNullPrimitive;\n * // type Nullish = null | undefined\n */\nexport type ITSNullPrimitive = null | undefined;\n"]}

package/lib/type/iterator.d.ts

@@ -1,2 +1,25 @@
+/**
+ * 迭代器類型定義
+ * Iterator Type Definitions
+ *
+ * 提供 Iterator 和 IteratorResult 的類型定義
+ * Provides Iterator and IteratorResult type definitions
+ */
+/**
+ * Iterator 類型
+ * Iterator type
+ *
+ * @example
+ * const iterator: ITSIterator<string> = {
+ *   next() { return { done: false, value: 'test' }; }
+ * };
+ */
 export type ITSIterator<T, TReturn = void, TNext = undefined> = Iterator<T, TReturn, TNext>;
+/**
+ * IteratorResult 類型
+ * IteratorResult type
+ *
+ * @example
+ * const result: ITSIteratorResult<string> = { done: false, value: 'test' };
+ */
 export type ITSIteratorResult<T, TReturn = void> = IteratorResult<T, TReturn>;

package/lib/type/iterator.js

@@ -1,3 +1,10 @@
 "use strict";
+/**
+ * 迭代器類型定義
+ * Iterator Type Definitions
+ *
+ * 提供 Iterator 和 IteratorResult 的類型定義
+ * Provides Iterator and IteratorResult type definitions
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=iterator.js.map

package/lib/type/iterator.js.map

@@ -1 +1 @@
-{"version":3,"file":"iterator.js","sourceRoot":"","sources":["iterator.ts"],"names":[],"mappings":"","sourcesContent":["\nexport type ITSIterator<T, TReturn = void, TNext = undefined> = Iterator<T, TReturn, TNext>;\n\nexport type ITSIteratorResult<T, TReturn = void> = IteratorResult<T, TReturn>;\n"]}
+{"version":3,"file":"iterator.js","sourceRoot":"","sources":["iterator.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG","sourcesContent":["/**\n * 迭代器類型定義\n * Iterator Type Definitions\n * \n * 提供 Iterator 和 IteratorResult 的類型定義\n * Provides Iterator and IteratorResult type definitions\n */\n\n/**\n * Iterator 類型\n * Iterator type\n * \n * @example\n * const iterator: ITSIterator<string> = {\n *   next() { return { done: false, value: 'test' }; }\n * };\n */\nexport type ITSIterator<T, TReturn = void, TNext = undefined> = Iterator<T, TReturn, TNext>;\n\n/**\n * IteratorResult 類型\n * IteratorResult type\n * \n * @example\n * const result: ITSIteratorResult<string> = { done: false, value: 'test' };\n */\nexport type ITSIteratorResult<T, TReturn = void> = IteratorResult<T, TReturn>;\n"]}

package/lib/type/promise.d.ts

@@ -1,21 +1,81 @@
 /**
+ * Promise 類型工具
+ * Promise Type Utilities
+ *
+ * 提供 Promise 相關的類型操作工具
+ * Provides Promise-related type manipulation utilities
+ *
  * Created by user on 2019/6/11.
  */
 /**
- * Same property names, but make the value a promise instead of a concrete one
+ * 延遲物件類型：將物件的所有屬性包裝為 Promise
+ * Deferred object type: wraps all properties of an object in Promise
+ *
+ * 保持相同的屬性名稱，但將值類型包裝為 Promise
+ * Keeps the same property names, but wraps value types in Promise
+ *
  * @see https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-1.html
+ *
+ * @example
+ * interface User {
+ *   id: number;
+ *   name: string;
+ * }
+ * type DeferredUser = ITSDeferred<User>;
+ * // type DeferredUser = { id: Promise<number>; name: Promise<string>; }
  */
 export type ITSDeferred<T> = {
     [P in keyof T]: Promise<T[P]>;
 };
+/**
+ * Promise 解決結果介面
+ * Promise fulfilled result interface
+ *
+ * 表示 Promise 已成功解決
+ * Represents a promise that has been successfully resolved
+ *
+ * @example
+ * const fulfilled: ITSPromiseFulfilledResult<string> = {
+ *   status: "fulfilled",
+ *   value: "success"
+ * };
+ */
 export interface ITSPromiseFulfilledResult<T> {
+    /** 解決狀態 / Fulfilled status */
     status: "fulfilled";
+    /** 解決值 / Resolved value */
     value: T;
+    /** 永不存在的拒絕原因 / Reason that never exists */
     reason?: never;
 }
+/**
+ * Promise 拒絕結果介面
+ * Promise rejected result interface
+ *
+ * 表示 Promise 被拒絕
+ * Represents a promise that has been rejected
+ *
+ * @example
+ * const rejected: ITSPromiseRejectedResult<Error> = {
+ *   status: "rejected",
+ *   reason: new Error("failed")
+ * };
+ */
 export interface ITSPromiseRejectedResult<E = any> {
+    /** 拒絕狀態 / Rejected status */
     status: "rejected";
+    /** 拒絕原因 / Rejection reason */
     reason: E;
+    /** 永不存在的解決值 / Value that never exists */
     value?: never;
 }
+/**
+ * Promise settled 結果類型：解決或拒絕結果的聯合類型
+ * Promise settled result type: union of fulfilled or rejected result
+ *
+ * @example
+ * const result: ITSPromiseSettledResult<string> = Math.random() > 0.5
+ *   ? { status: "fulfilled", value: "success" }
+ *   : { status: "rejected", reason: new Error("failed") };
+ */
 export type ITSPromiseSettledResult<T, E = any> = ITSPromiseFulfilledResult<T> | ITSPromiseRejectedResult<E>;