ts-type 3.0.7 → 3.0.10

package/docs/README.md

@@ -111,6 +111,17 @@ ts-type is a TypeScript type utility library that provides rich type manipulatio
 
 ---
 
+### 9. [相同邏輯的不同實現 / Different Implementations of Same Logic](10-same-logic-diff-impl.md)
+
+記錄功能相似但實現方式不同的類型，幫助選擇適合的類型。
+
+- 互斥鍵: `ITSPickOne` vs `ITSRequireOnlyOne`
+- 唯讀操作: 類型級別 vs 記錄級別
+- 空類型: 記錄 vs 元組
+- 列舉操作: 類型定義 vs 操作工具
+
+---
+
 ## 快速開始 / Quick Start
 
 ### 安裝 / Installation

package/lib/_build-in.d.ts

@@ -11,6 +11,13 @@
  * 取得函數的參數類型
  * Get the parameter types of a function
  *
+ * @example
+ * function greet(name: string, age: number): string {
+ *   return `Hello, ${name}, you are ${age} years old.`;
+ * }
+ * type Params = ITSParameters<typeof greet>;
+ * // type Params = [name: string, age: number]
+ *
  * @see Parameters
  */
 export type ITSParameters<T extends (...args: any[]) => any> = Parameters<T>;
@@ -18,6 +25,13 @@ export type ITSParameters<T extends (...args: any[]) => any> = Parameters<T>;
  * 取得建構函數的參數類型
  * Get the constructor parameter types
  *
+ * @example
+ * class User {
+ *   constructor(public name: string, public age: number) {}
+ * }
+ * type CtorParams = ITSConstructorParameters<typeof User>;
+ * // type CtorParams = [name: string, age: number]
+ *
  * @see ConstructorParameters
  */
 export type ITSConstructorParameters<T extends new (...args: any[]) => any> = ConstructorParameters<T>;
@@ -25,6 +39,11 @@ export type ITSConstructorParameters<T extends new (...args: any[]) => any> = Co
  * 將類型的所有屬性設為可選
  * Make all properties of T optional
  *
+ * @example
+ * interface User { name: string; age: number; }
+ * type PartialUser = ITSPartial<User>;
+ * // type PartialUser = { name?: string; age?: number; }
+ *
  * @see Partial
  */
 export type ITSPartial<T> = Partial<T>;
@@ -32,6 +51,11 @@ export type ITSPartial<T> = Partial<T>;
  * 從類型 T 中選取指定的屬性 K
  * Pick a set of properties K from T
  *
+ * @example
+ * interface User { name: string; age: number; email: string; }
+ * type PickedUser = ITSPick<User, 'name' | 'age'>;
+ * // type PickedUser = { name: string; age: number; }
+ *
  * @see Pick
  */
 export type ITSPick<T, K extends keyof T = keyof T> = Pick<T, K>;
@@ -39,33 +63,73 @@ export type ITSPick<T, K extends keyof T = keyof T> = Pick<T, K>;
  * 取得建構函數實例的類型
  * Get the instance type created by a constructor
  *
+ * @example
+ * class User { name: string; }
+ * type UserInstance = ITSInstanceType<typeof User>;
+ * // type UserInstance = User
+ *
  * @see InstanceType
  */
 export type ITSInstanceType<T extends new (...args: any[]) => any> = InstanceType<T>;
 /**
  * 類別裝飾器類型
  * Class decorator type
+ *
+ * @example
+ * const myClassDecorator: ITSClassDecorator = (target) => {
+ *   console.log(`Decorating ${target.name}`);
+ *   return target;
+ * };
+ *
+ * @decorator
  */
 export type ITSClassDecorator = <TFunction extends Function>(target: TFunction) => TFunction | void;
 /**
  * 屬性裝飾器類型
  * Property decorator type
+ *
+ * @example
+ * const myPropertyDecorator: ITSPropertyDecorator = (target, propertyKey) => {
+ *   console.log(`Decorating property ${String(propertyKey)} on`, target);
+ * };
+ *
+ * @decorator
  */
 export type ITSPropertyDecorator = (target: object, propertyKey: string | symbol) => void;
 /**
  * 方法裝飾器類型
  * Method decorator type
+ *
+ * @example
+ * const myMethodDecorator: ITSMethodDecorator = (target, propertyKey, descriptor) => {
+ *   console.log(`Decorating method ${String(propertyKey)}`);
+ *   return descriptor;
+ * };
+ *
+ * @decorator
  */
 export type ITSMethodDecorator = <T>(target: object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<T>) => TypedPropertyDescriptor<T> | void;
 /**
  * 參數裝飾器類型
  * Parameter decorator type
+ *
+ * @example
+ * const myParameterDecorator: ITSParameterDecorator = (target, propertyKey, parameterIndex) => {
+ *   console.log(`Decorating parameter ${parameterIndex} of ${String(propertyKey)}`);
+ * };
+ *
+ * @decorator
  */
 export type ITSParameterDecorator = (target: object, propertyKey: string | symbol, parameterIndex: number) => void;
 /**
  * 從 T 中排除 null 和 undefined
  * Exclude null and undefined from T
  *
+ * @example
+ * type Test = string | number | null | undefined;
+ * type NonNull = ITSNonNullable<Test>;
+ * // type NonNull = string | number
+ *
  * @see NonNullable
  * @see https://devblogs.microsoft.com/typescript/announcing-typescript-4-8/#improved-intersection-reduction-union-compatibility-and-narrowing
  */

package/lib/_build-in.js.map

@@ -1 +1 @@
-{"version":3,"file":"_build-in.js","sourceRoot":"","sources":["_build-in.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG","sourcesContent":["/**\n * Created by user on 2019/6/11.\n * \n * 重新導出內建類型\n * Re-export built-in types\n * \n * 在某些情況下 IDE 無法正確識別類型，此文件提供統一的類別導出\n * In some cases IDE cannot correctly identify types, this file provides unified type exports\n */\n\n/**\n * 取得函數的參數類型\n * Get the parameter types of a function\n * \n * @see Parameters\n */\nexport type ITSParameters<T extends (...args: any[]) => any> = Parameters<T>\n/**\n * 取得建構函數的參數類型\n * Get the constructor parameter types\n * \n * @see ConstructorParameters\n */\nexport type ITSConstructorParameters<T extends new (...args: any[]) => any> = ConstructorParameters<T>\n/**\n * 將類型的所有屬性設為可選\n * Make all properties of T optional\n * \n * @see Partial\n */\nexport type ITSPartial<T> = Partial<T>\n/**\n * 從類型 T 中選取指定的屬性 K\n * Pick a set of properties K from T\n * \n * @see Pick\n */\nexport type ITSPick<T, K extends keyof T = keyof T> = Pick<T, K>\n/**\n * 取得建構函數實例的類型\n * Get the instance type created by a constructor\n * \n * @see InstanceType\n */\nexport type ITSInstanceType<T extends new (...args: any[]) => any> = InstanceType<T>\n\n\n/**\n * 類別裝飾器類型\n * Class decorator type\n */\nexport type ITSClassDecorator = <TFunction extends Function>(target: TFunction) => TFunction | void;\n/**\n * 屬性裝飾器類型\n * Property decorator type\n */\nexport type ITSPropertyDecorator = (target: object, propertyKey: string | symbol) => void;\n/**\n * 方法裝飾器類型\n * Method decorator type\n */\nexport type ITSMethodDecorator = <T>(target: object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<T>) => TypedPropertyDescriptor<T> | void;\n/**\n * 參數裝飾器類型\n * Parameter decorator type\n */\nexport type ITSParameterDecorator = (target: object, propertyKey: string | symbol, parameterIndex: number) => void;\n\n/**\n * 從 T 中排除 null 和 undefined\n * Exclude null and undefined from T\n * \n * @see NonNullable\n * @see https://devblogs.microsoft.com/typescript/announcing-typescript-4-8/#improved-intersection-reduction-union-compatibility-and-narrowing\n */\nexport type ITSNonNullable<T> = NonNullable<T>;\n"]}
+{"version":3,"file":"_build-in.js","sourceRoot":"","sources":["_build-in.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG","sourcesContent":["/**\n * Created by user on 2019/6/11.\n * \n * 重新導出內建類型\n * Re-export built-in types\n * \n * 在某些情況下 IDE 無法正確識別類型，此文件提供統一的類別導出\n * In some cases IDE cannot correctly identify types, this file provides unified type exports\n */\n\n/**\n * 取得函數的參數類型\n * Get the parameter types of a function\n * \n * @example\n * function greet(name: string, age: number): string {\n *   return `Hello, ${name}, you are ${age} years old.`;\n * }\n * type Params = ITSParameters<typeof greet>;\n * // type Params = [name: string, age: number]\n * \n * @see Parameters\n */\nexport type ITSParameters<T extends (...args: any[]) => any> = Parameters<T>\n/**\n * 取得建構函數的參數類型\n * Get the constructor parameter types\n * \n * @example\n * class User {\n *   constructor(public name: string, public age: number) {}\n * }\n * type CtorParams = ITSConstructorParameters<typeof User>;\n * // type CtorParams = [name: string, age: number]\n * \n * @see ConstructorParameters\n */\nexport type ITSConstructorParameters<T extends new (...args: any[]) => any> = ConstructorParameters<T>\n/**\n * 將類型的所有屬性設為可選\n * Make all properties of T optional\n * \n * @example\n * interface User { name: string; age: number; }\n * type PartialUser = ITSPartial<User>;\n * // type PartialUser = { name?: string; age?: number; }\n * \n * @see Partial\n */\nexport type ITSPartial<T> = Partial<T>\n/**\n * 從類型 T 中選取指定的屬性 K\n * Pick a set of properties K from T\n * \n * @example\n * interface User { name: string; age: number; email: string; }\n * type PickedUser = ITSPick<User, 'name' | 'age'>;\n * // type PickedUser = { name: string; age: number; }\n * \n * @see Pick\n */\nexport type ITSPick<T, K extends keyof T = keyof T> = Pick<T, K>\n/**\n * 取得建構函數實例的類型\n * Get the instance type created by a constructor\n * \n * @example\n * class User { name: string; }\n * type UserInstance = ITSInstanceType<typeof User>;\n * // type UserInstance = User\n * \n * @see InstanceType\n */\nexport type ITSInstanceType<T extends new (...args: any[]) => any> = InstanceType<T>\n\n\n/**\n * 類別裝飾器類型\n * Class decorator type\n * \n * @example\n * const myClassDecorator: ITSClassDecorator = (target) => {\n *   console.log(`Decorating ${target.name}`);\n *   return target;\n * };\n * \n * @decorator\n */\nexport type ITSClassDecorator = <TFunction extends Function>(target: TFunction) => TFunction | void;\n/**\n * 屬性裝飾器類型\n * Property decorator type\n * \n * @example\n * const myPropertyDecorator: ITSPropertyDecorator = (target, propertyKey) => {\n *   console.log(`Decorating property ${String(propertyKey)} on`, target);\n * };\n * \n * @decorator\n */\nexport type ITSPropertyDecorator = (target: object, propertyKey: string | symbol) => void;\n/**\n * 方法裝飾器類型\n * Method decorator type\n * \n * @example\n * const myMethodDecorator: ITSMethodDecorator = (target, propertyKey, descriptor) => {\n *   console.log(`Decorating method ${String(propertyKey)}`);\n *   return descriptor;\n * };\n * \n * @decorator\n */\nexport type ITSMethodDecorator = <T>(target: object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<T>) => TypedPropertyDescriptor<T> | void;\n/**\n * 參數裝飾器類型\n * Parameter decorator type\n * \n * @example\n * const myParameterDecorator: ITSParameterDecorator = (target, propertyKey, parameterIndex) => {\n *   console.log(`Decorating parameter ${parameterIndex} of ${String(propertyKey)}`);\n * };\n * \n * @decorator\n */\nexport type ITSParameterDecorator = (target: object, propertyKey: string | symbol, parameterIndex: number) => void;\n\n/**\n * 從 T 中排除 null 和 undefined\n * Exclude null and undefined from T\n * \n * @example\n * type Test = string | number | null | undefined;\n * type NonNull = ITSNonNullable<Test>;\n * // type NonNull = string | number\n * \n * @see NonNullable\n * @see https://devblogs.microsoft.com/typescript/announcing-typescript-4-8/#improved-intersection-reduction-union-compatibility-and-narrowing\n */\nexport type ITSNonNullable<T> = NonNullable<T>;\n"]}

package/lib/generic.d.ts

@@ -1,6 +1,14 @@
 /**
  * 類型函數：返回指定類型的函數
  * Type function: a function that returns the specified type
+ *
+ * @example
+ * type StringFunc = ITSTypeFunction<string>;
+ * // type StringFunc = (...args: any[]) => string
+ *
+ * @example
+ * type NumberFunc = ITSTypeFunction<number>;
+ * // type NumberFunc = (...args: any[]) => number
  */
 export type ITSTypeFunction<T> = (...args: any[]) => T;
 /**

package/lib/generic.js.map

@@ -1 +1 @@
-{"version":3,"file":"generic.js","sourceRoot":"","sources":["generic.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * 類型函數：返回指定類型的函數\n * Type function: a function that returns the specified type\n */\nexport type ITSTypeFunction<T> = (...args: any[]) => T;\n\n/**\n * 類似 Map 的介面定義\n * Map-like interface definition\n */\nexport interface ITSMapLike<K, V>\n{\n\t/**\n\t * 取得指定鍵的值\n\t * Get the value for the specified key\n\t */\n\tget(key: K): V | undefined;\n\n\t/**\n\t * 檢查是否包含指定鍵\n\t * Check if the map contains the specified key\n\t */\n\thas(key: K): boolean;\n}\n\n/**\n * 類似 Set 的介面定義\n * Set-like interface definition\n */\nexport interface ITSSetLike<V>\n{\n\t/**\n\t * 檢查是否包含指定值\n\t * Check if the set contains the specified value\n\t */\n\thas(value: V): boolean;\n}\n\n/**\n * 可解析的類型：支援直接值或 PromiseLike\n * Resolvable type: supports direct value or PromiseLike\n * \n * @see bluebird\n */\nexport type ITSResolvable<R> = R | PromiseLike<R>;\n\n/**\n * 可寫入的類陣列介面\n * Writable array-like interface\n */\nexport interface ITSArrayLikeWriteable<T>\n{\n\t/** 只讀的長度屬性 / Readonly length property */\n\treadonly length: number;\n\t/** 數字索引存取 / Numeric index access */\n\t[n: number]: T;\n}\n"]}
+{"version":3,"file":"generic.js","sourceRoot":"","sources":["generic.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * 類型函數：返回指定類型的函數\n * Type function: a function that returns the specified type\n * \n * @example\n * type StringFunc = ITSTypeFunction<string>;\n * // type StringFunc = (...args: any[]) => string\n * \n * @example\n * type NumberFunc = ITSTypeFunction<number>;\n * // type NumberFunc = (...args: any[]) => number\n */\nexport type ITSTypeFunction<T> = (...args: any[]) => T;\n\n/**\n * 類似 Map 的介面定義\n * Map-like interface definition\n */\nexport interface ITSMapLike<K, V>\n{\n\t/**\n\t * 取得指定鍵的值\n\t * Get the value for the specified key\n\t */\n\tget(key: K): V | undefined;\n\n\t/**\n\t * 檢查是否包含指定鍵\n\t * Check if the map contains the specified key\n\t */\n\thas(key: K): boolean;\n}\n\n/**\n * 類似 Set 的介面定義\n * Set-like interface definition\n */\nexport interface ITSSetLike<V>\n{\n\t/**\n\t * 檢查是否包含指定值\n\t * Check if the set contains the specified value\n\t */\n\thas(value: V): boolean;\n}\n\n/**\n * 可解析的類型：支援直接值或 PromiseLike\n * Resolvable type: supports direct value or PromiseLike\n * \n * @see bluebird\n */\nexport type ITSResolvable<R> = R | PromiseLike<R>;\n\n/**\n * 可寫入的類陣列介面\n * Writable array-like interface\n */\nexport interface ITSArrayLikeWriteable<T>\n{\n\t/** 只讀的長度屬性 / Readonly length property */\n\treadonly length: number;\n\t/** 數字索引存取 / Numeric index access */\n\t[n: number]: T;\n}\n"]}

package/lib/helper/record/pick-one.d.ts

@@ -3,6 +3,13 @@ import { ITSPartialRecord } from '../../type/record/partial';
  * 在项目开发中，很多时候会遇到一种场景，需要定义一个对象的类型，此类型必须包含某n个字段中的其中一种，且只选一个。
  *
  * @see https://juejin.cn/post/7150316226009382919#heading-2
+ * @see {@link ITSRequireOnlyOne} 另一種實現方式
+ *
+ * @example
+ * interface User { name?: string; age?: number; }
+ * type OnlyOne2 = ITSPickOne<User, 'name' | 'age'>;
+ * // 輸出結果：
+ * // type OnlyOne2 = { name: string; age?: void; } | { age: number; name?: void; }
  */
 export type ITSPickOne<T, Keys extends keyof T = keyof T> = {
     [K in Keys]: Record<K, T[K]> & ITSPartialRecord<Exclude<keyof T, K>, void>;

package/lib/helper/record/pick-one.js.map

@@ -1 +1 @@
-{"version":3,"file":"pick-one.js","sourceRoot":"","sources":["pick-one.ts"],"names":[],"mappings":"","sourcesContent":["import { ITSPartialRecord } from '../../type/record/partial';\n\n/**\n * 在项目开发中，很多时候会遇到一种场景，需要定义一个对象的类型，此类型必须包含某n个字段中的其中一种，且只选一个。\n *\n * @see https://juejin.cn/post/7150316226009382919#heading-2\n */\nexport type ITSPickOne<T, Keys extends keyof T = keyof T> = {\n\t[K in Keys]: Record<K, T[K]> & ITSPartialRecord<Exclude<keyof T, K>, void>\n}[Keys]\n"]}
+{"version":3,"file":"pick-one.js","sourceRoot":"","sources":["pick-one.ts"],"names":[],"mappings":"","sourcesContent":["import { ITSPartialRecord } from '../../type/record/partial';\n\n/**\n * 在项目开发中，很多时候会遇到一种场景，需要定义一个对象的类型，此类型必须包含某n个字段中的其中一种，且只选一个。\n *\n * @see https://juejin.cn/post/7150316226009382919#heading-2\n * @see {@link ITSRequireOnlyOne} 另一種實現方式\n *\n * @example\n * interface User { name?: string; age?: number; }\n * type OnlyOne2 = ITSPickOne<User, 'name' | 'age'>;\n * // 輸出結果：\n * // type OnlyOne2 = { name: string; age?: void; } | { age: number; name?: void; }\n */\nexport type ITSPickOne<T, Keys extends keyof T = keyof T> = {\n\t[K in Keys]: Record<K, T[K]> & ITSPartialRecord<Exclude<keyof T, K>, void>\n}[Keys]\n"]}

package/lib/type/record.d.ts

@@ -198,10 +198,13 @@ export type ITSRequireAtLeastOne<T, Keys extends keyof T = keyof T> = Omit<T, Ke
  * Ensure the object can only have exactly one of the specified key sets (mutually exclusive)
  *
  * @see https://stackoverflow.com/questions/40510611/typescript-interface-require-one-of-two-properties-to-exist
+ * @see {@link ITSPickOne} 另一種實現方式，使用 `void` 作為其餘鍵的類型
  *
  * @example
  * interface User { name?: string; age?: number; }
- * type OnlyOne = ITSRequireOnlyOne<User, 'name' | 'age'>;
+ * type OnlyOne1 = ITSRequireOnlyOne<User, 'name' | 'age'>;
+ * // 輸出結果：
+ * // type OnlyOne1 = { name: string; age?: never; } | { age: number; name?: never; }
  * // 只能提供 name 或 age 其中一個，不能同時提供
  */
 export type ITSRequireOnlyOne<T, Keys extends keyof T = keyof T> = Omit<T, Keys> & {

package/lib/type/record.js.map

@@ -1 +1 @@
-{"version":3,"file":"record.js","sourceRoot":"","sources":["record.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG","sourcesContent":["/**\n * 記錄（Record）類型操作工具\n * Record Type Manipulation Utilities\n * \n * 提供物件類型選擇、覆寫、合併等操作\n * Provides object type selection, overwrite, merge and other operations\n * \n * Created by user on 2019/6/11.\n */\n\nimport type { ITSKeyofBothDiff, ITSKeyofBothSame, ITSKeyofDiff, ITSKeyofSame } from '../helper/filter';\n\nexport type { ITSRequireRecord, ITSPartialRecord } from '../type/record/partial';\n\n/**\n * 取得兩個鍵集合的差異（已棄用）\n * Get the difference between two key sets (deprecated)\n * \n * @deprecated 請使用 ITSKeyofDiff 取代 / Please use ITSKeyofDiff instead\n */\nexport type ITSDiff<T extends keyof any, U extends keyof any> = (\n\t{ [P in T]: P }\n\t&\n\t{ [P in U]: never }\n\t&\n\t{ [x: string]: never }\n\t)[T];\n\n/**\n * 選擇 T 中與 U 相同的鍵\n * Pick keys from T that are the same as U\n * \n * @example\n * type A = { a: 1; b: 2; };\n * type B = { a: 3; c: 4; };\n * type Result = ITSPickSame<A, B>;\n * // type Result = { a: 1 }\n */\nexport type ITSPickSame<T, U> = Pick<T, ITSKeyofSame<T, U>>;\n\n/**\n * 選擇 T 中與 U 不同的鍵\n * Pick keys from T that are different from U\n * \n * @example\n * type A = { a: 1; b: 2; };\n * type B = { a: 3; c: 4; };\n * type Result = ITSPickDiff<A, B>;\n * // type Result = { b: 2 }\n */\nexport type ITSPickDiff<T, U> = Pick<T, ITSKeyofDiff<T, U>>;\n\n/**\n * 選擇 T 與 U 中同時存在的鍵\n * Pick keys that exist in both T and U\n * \n * @example\n * type A = { a: 1; b: 2; };\n * type B = { a: 3; c: 4; };\n * type Result = ITSPickBothSame<A, B>;\n * // type Result = { a: 1 }\n */\nexport type ITSPickBothSame<T, U> = Pick<T & U, ITSKeyofBothSame<T, U>>;\n\n/**\n * 選擇 T 與 U 中不同時存在的鍵\n * Pick keys that do not exist in both T and U\n * \n * @example\n * type A = { a: 1; b: 2; };\n * type B = { a: 3; c: 4; };\n * type Result = ITSPickBothDiff<A, B>;\n * // type Result = { b: 2; c: 4 }\n */\nexport type ITSPickBothDiff<T, U> = Pick<T & U, ITSKeyofBothDiff<T, U>>;\n\n/**\n * 選擇指定鍵集合 K（必須是 T 與 U 中同時存在的鍵）\n * Pick a specified key set K (must be keys that exist in both T and U)\n */\nexport type ITSPickBoth<T, U, K extends ITSKeyofBothSame<T, U> = ITSKeyofBothSame<T, U>> = Pick<T & U, K>;\n\n/**\n * 取得物件成員的類型\n * Get the type of an object member\n * \n * @see https://stackoverflow.com/questions/49198713/override-the-properties-of-an-interface-in-typescript\n */\nexport type ITSPickMember<T, K extends keyof T> = T[K];\n\n/**\n * 排除指定鍵（已棄用）\n * Exclude specified keys (deprecated)\n * \n * @deprecated 請使用 Omit 取代 / Please use Omit instead\n */\nexport type ITSPickNot<T, K extends keyof T> = Omit<T, K>;\n\n/**\n * 覆寫物件類型的屬性\n * Overwrite properties of an object type\n * \n * 用 U 中的屬性覆寫 T 中的同名屬性\n * Overwrites properties in T with the same name from U\n * \n * @see https://stackoverflow.com/questions/49198713/override-the-properties-of-an-interface-in-typescript\n * \n * @example\n * interface A1 { s: string }\n * type A2 = ITSOverwrite<A1, { s: number }>;\n * // type A2 = { s: number }\n */\nexport type ITSOverwrite<T, U> = Omit<T, keyof U> & U;\n\n/**\n * 合併兩個物件類型，處理衝突屬性\n * Merge two object types, handling conflicting properties\n * \n * 對於 T 與 U 中同時存在的鍵，取兩者的聯集類型\n * For keys that exist in both T and U, takes the union type of both\n * \n * @example\n * type Test1 = { id: number, code: string }\n * type Test2 = { id: string, code: number }\n * type Test3 = ITSMergeBoth<Test1, Test2>\n * // type Test3 = { id: string | number; code: string | number }\n * @see https://github.com/microsoft/TypeScript/issues/35627\n */\nexport type ITSMergeBoth<T, U> = ITSPickBothDiff<T, U> & Pick<T | U, ITSKeyofBothSame<T, U>>;\n\n/**\n * 選擇指定鍵並設為必填\n * Pick specified keys and mark as Required\n * \n * @example\n * interface User { name?: string; age?: number; email?: string; }\n * type RequiredName = ITSRequiredPick<User, 'name'>;\n * // type RequiredName = { name: string; age?: number; email?: string; }\n */\nexport type ITSRequiredPick<T, K extends keyof T = keyof T> = {\n\t[P in K]-?: T[P];\n};\n\n/**\n * 選擇指定鍵並設為可選\n * Pick specified keys and mark as Partial\n * \n * @example\n * interface User { name: string; age: number; email: string; }\n * type PartialName = ITSPartialPick<User, 'name'>;\n * // type PartialName = { name?: string; age: number; email: string; }\n */\nexport type ITSPartialPick<T, K extends keyof T = keyof T> = {\n\t[P in K]?: T[P];\n};\n\n/**\n * 複製類型並將指定鍵RK設為必填，其他鍵Pk設為可選\n * Clone a type and mark specified keys as Required, other keys as Partial\n * \n * @example\n * interface User { name: string; age: number; email: string; }\n * type Result = ITSPickExtra<User, 'name', 'email'>;\n * // type Result = { name: string; } & { age?: number; email?: string; }\n */\nexport type ITSPickExtra<T, RK extends keyof T, PK extends Exclude<keyof T, RK> = Exclude<keyof T, RK>> =\n\tITSRequiredPick<T, RK>\n\t& ITSPartialPick<T, PK>;\n\n/**\n * 複製類型並將指定鍵Pk設為可選，其他鍵Rk設為必填（與 ITSPickExtra 相反）\n * Clone a type and mark specified keys as Partial, other keys as Required (opposite of ITSPickExtra)\n * \n * @example\n * interface User { name: string; age: number; email: string; }\n * type Result = ITSPickExtra2<User, 'name', 'email'>;\n * // type Result = { name?: string; } & { age: number; email: string; }\n */\nexport type ITSPickExtra2<T, PK extends keyof T, RK extends Exclude<keyof T, PK> = Exclude<keyof T, PK>> =\n\tITSRequiredPick<T, RK>\n\t& ITSPartialPick<T, PK>;\n\n/**\n * 保留指定鍵為必填，其他鍵不變\n * Keep specified keys as Required, other keys unchanged\n * \n * @example\n * interface User { name: string; age: number; email: string; }\n * type Result = ITSRequiredWith<User, 'name'>;\n * // type Result = { name: string; age: number; email: string; }\n */\nexport type ITSRequiredWith<T, K extends keyof T> = Omit<T, K> & ITSRequiredPick<T, K>;\n\n/**\n * 保留指定鍵為可選，其他鍵不變\n * Keep specified keys as Partial, other keys unchanged\n * \n * @example\n * interface User { name: string; age: number; email: string; }\n * type Result = ITSPartialWith<User, 'name'>;\n * // type Result = { name?: string; age: number; email: string; }\n */\nexport type ITSPartialWith<T, K extends keyof T> = Omit<T, K> & ITSPartialPick<T, K>;\n\n/**\n * 確保物件至少具有指定的鍵集合中的一個\n * Ensure the object has at least one of the specified key sets\n * \n * @see https://stackoverflow.com/questions/40510611/typescript-interface-require-one-of-two-properties-to-exist\n * \n * @example\n * interface User { name?: string; age?: number; }\n * type AtLeastOne = ITSRequireAtLeastOne<User, 'name' | 'age'>;\n * // 需要至少提供 name 或 age 其中一個\n */\nexport type ITSRequireAtLeastOne<T, Keys extends keyof T = keyof T> =\n\tOmit<T, Keys>\n\t& {\n\t[K in Keys]-?: ITSRequiredPick<T, K>\n\t& ITSPartialPick<T, Exclude<Keys, K>>\n}[Keys];\n\n/**\n * 確保物件只能具有指定的鍵集合中的其中一個（互斥）\n * Ensure the object can only have exactly one of the specified key sets (mutually exclusive)\n * \n * @see https://stackoverflow.com/questions/40510611/typescript-interface-require-one-of-two-properties-to-exist\n * \n * @example\n * interface User { name?: string; age?: number; }\n * type OnlyOne = ITSRequireOnlyOne<User, 'name' | 'age'>;\n * // 只能提供 name 或 age 其中一個，不能同時提供\n */\nexport type ITSRequireOnlyOne<T, Keys extends keyof T = keyof T> =\n\tOmit<T, Keys>\n\t& {\n\t[K in Keys]-?: ITSRequiredPick<T, K>\n\t& Partial<Record<Exclude<Keys, K>, never>>\n}[Keys];\n"]}
+{"version":3,"file":"record.js","sourceRoot":"","sources":["record.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG","sourcesContent":["/**\n * 記錄（Record）類型操作工具\n * Record Type Manipulation Utilities\n * \n * 提供物件類型選擇、覆寫、合併等操作\n * Provides object type selection, overwrite, merge and other operations\n * \n * Created by user on 2019/6/11.\n */\n\nimport type { ITSKeyofBothDiff, ITSKeyofBothSame, ITSKeyofDiff, ITSKeyofSame } from '../helper/filter';\n\nexport type { ITSRequireRecord, ITSPartialRecord } from '../type/record/partial';\n\n/**\n * 取得兩個鍵集合的差異（已棄用）\n * Get the difference between two key sets (deprecated)\n * \n * @deprecated 請使用 ITSKeyofDiff 取代 / Please use ITSKeyofDiff instead\n */\nexport type ITSDiff<T extends keyof any, U extends keyof any> = (\n\t{ [P in T]: P }\n\t&\n\t{ [P in U]: never }\n\t&\n\t{ [x: string]: never }\n\t)[T];\n\n/**\n * 選擇 T 中與 U 相同的鍵\n * Pick keys from T that are the same as U\n * \n * @example\n * type A = { a: 1; b: 2; };\n * type B = { a: 3; c: 4; };\n * type Result = ITSPickSame<A, B>;\n * // type Result = { a: 1 }\n */\nexport type ITSPickSame<T, U> = Pick<T, ITSKeyofSame<T, U>>;\n\n/**\n * 選擇 T 中與 U 不同的鍵\n * Pick keys from T that are different from U\n * \n * @example\n * type A = { a: 1; b: 2; };\n * type B = { a: 3; c: 4; };\n * type Result = ITSPickDiff<A, B>;\n * // type Result = { b: 2 }\n */\nexport type ITSPickDiff<T, U> = Pick<T, ITSKeyofDiff<T, U>>;\n\n/**\n * 選擇 T 與 U 中同時存在的鍵\n * Pick keys that exist in both T and U\n * \n * @example\n * type A = { a: 1; b: 2; };\n * type B = { a: 3; c: 4; };\n * type Result = ITSPickBothSame<A, B>;\n * // type Result = { a: 1 }\n */\nexport type ITSPickBothSame<T, U> = Pick<T & U, ITSKeyofBothSame<T, U>>;\n\n/**\n * 選擇 T 與 U 中不同時存在的鍵\n * Pick keys that do not exist in both T and U\n * \n * @example\n * type A = { a: 1; b: 2; };\n * type B = { a: 3; c: 4; };\n * type Result = ITSPickBothDiff<A, B>;\n * // type Result = { b: 2; c: 4 }\n */\nexport type ITSPickBothDiff<T, U> = Pick<T & U, ITSKeyofBothDiff<T, U>>;\n\n/**\n * 選擇指定鍵集合 K（必須是 T 與 U 中同時存在的鍵）\n * Pick a specified key set K (must be keys that exist in both T and U)\n */\nexport type ITSPickBoth<T, U, K extends ITSKeyofBothSame<T, U> = ITSKeyofBothSame<T, U>> = Pick<T & U, K>;\n\n/**\n * 取得物件成員的類型\n * Get the type of an object member\n * \n * @see https://stackoverflow.com/questions/49198713/override-the-properties-of-an-interface-in-typescript\n */\nexport type ITSPickMember<T, K extends keyof T> = T[K];\n\n/**\n * 排除指定鍵（已棄用）\n * Exclude specified keys (deprecated)\n * \n * @deprecated 請使用 Omit 取代 / Please use Omit instead\n */\nexport type ITSPickNot<T, K extends keyof T> = Omit<T, K>;\n\n/**\n * 覆寫物件類型的屬性\n * Overwrite properties of an object type\n * \n * 用 U 中的屬性覆寫 T 中的同名屬性\n * Overwrites properties in T with the same name from U\n * \n * @see https://stackoverflow.com/questions/49198713/override-the-properties-of-an-interface-in-typescript\n * \n * @example\n * interface A1 { s: string }\n * type A2 = ITSOverwrite<A1, { s: number }>;\n * // type A2 = { s: number }\n */\nexport type ITSOverwrite<T, U> = Omit<T, keyof U> & U;\n\n/**\n * 合併兩個物件類型，處理衝突屬性\n * Merge two object types, handling conflicting properties\n * \n * 對於 T 與 U 中同時存在的鍵，取兩者的聯集類型\n * For keys that exist in both T and U, takes the union type of both\n * \n * @example\n * type Test1 = { id: number, code: string }\n * type Test2 = { id: string, code: number }\n * type Test3 = ITSMergeBoth<Test1, Test2>\n * // type Test3 = { id: string | number; code: string | number }\n * @see https://github.com/microsoft/TypeScript/issues/35627\n */\nexport type ITSMergeBoth<T, U> = ITSPickBothDiff<T, U> & Pick<T | U, ITSKeyofBothSame<T, U>>;\n\n/**\n * 選擇指定鍵並設為必填\n * Pick specified keys and mark as Required\n * \n * @example\n * interface User { name?: string; age?: number; email?: string; }\n * type RequiredName = ITSRequiredPick<User, 'name'>;\n * // type RequiredName = { name: string; age?: number; email?: string; }\n */\nexport type ITSRequiredPick<T, K extends keyof T = keyof T> = {\n\t[P in K]-?: T[P];\n};\n\n/**\n * 選擇指定鍵並設為可選\n * Pick specified keys and mark as Partial\n * \n * @example\n * interface User { name: string; age: number; email: string; }\n * type PartialName = ITSPartialPick<User, 'name'>;\n * // type PartialName = { name?: string; age: number; email: string; }\n */\nexport type ITSPartialPick<T, K extends keyof T = keyof T> = {\n\t[P in K]?: T[P];\n};\n\n/**\n * 複製類型並將指定鍵RK設為必填，其他鍵Pk設為可選\n * Clone a type and mark specified keys as Required, other keys as Partial\n * \n * @example\n * interface User { name: string; age: number; email: string; }\n * type Result = ITSPickExtra<User, 'name', 'email'>;\n * // type Result = { name: string; } & { age?: number; email?: string; }\n */\nexport type ITSPickExtra<T, RK extends keyof T, PK extends Exclude<keyof T, RK> = Exclude<keyof T, RK>> =\n\tITSRequiredPick<T, RK>\n\t& ITSPartialPick<T, PK>;\n\n/**\n * 複製類型並將指定鍵Pk設為可選，其他鍵Rk設為必填（與 ITSPickExtra 相反）\n * Clone a type and mark specified keys as Partial, other keys as Required (opposite of ITSPickExtra)\n * \n * @example\n * interface User { name: string; age: number; email: string; }\n * type Result = ITSPickExtra2<User, 'name', 'email'>;\n * // type Result = { name?: string; } & { age: number; email: string; }\n */\nexport type ITSPickExtra2<T, PK extends keyof T, RK extends Exclude<keyof T, PK> = Exclude<keyof T, PK>> =\n\tITSRequiredPick<T, RK>\n\t& ITSPartialPick<T, PK>;\n\n/**\n * 保留指定鍵為必填，其他鍵不變\n * Keep specified keys as Required, other keys unchanged\n * \n * @example\n * interface User { name: string; age: number; email: string; }\n * type Result = ITSRequiredWith<User, 'name'>;\n * // type Result = { name: string; age: number; email: string; }\n */\nexport type ITSRequiredWith<T, K extends keyof T> = Omit<T, K> & ITSRequiredPick<T, K>;\n\n/**\n * 保留指定鍵為可選，其他鍵不變\n * Keep specified keys as Partial, other keys unchanged\n * \n * @example\n * interface User { name: string; age: number; email: string; }\n * type Result = ITSPartialWith<User, 'name'>;\n * // type Result = { name?: string; age: number; email: string; }\n */\nexport type ITSPartialWith<T, K extends keyof T> = Omit<T, K> & ITSPartialPick<T, K>;\n\n/**\n * 確保物件至少具有指定的鍵集合中的一個\n * Ensure the object has at least one of the specified key sets\n * \n * @see https://stackoverflow.com/questions/40510611/typescript-interface-require-one-of-two-properties-to-exist\n * \n * @example\n * interface User { name?: string; age?: number; }\n * type AtLeastOne = ITSRequireAtLeastOne<User, 'name' | 'age'>;\n * // 需要至少提供 name 或 age 其中一個\n */\nexport type ITSRequireAtLeastOne<T, Keys extends keyof T = keyof T> =\n\tOmit<T, Keys>\n\t& {\n\t[K in Keys]-?: ITSRequiredPick<T, K>\n\t& ITSPartialPick<T, Exclude<Keys, K>>\n}[Keys];\n\n/**\n * 確保物件只能具有指定的鍵集合中的其中一個（互斥）\n * Ensure the object can only have exactly one of the specified key sets (mutually exclusive)\n *\n * @see https://stackoverflow.com/questions/40510611/typescript-interface-require-one-of-two-properties-to-exist\n * @see {@link ITSPickOne} 另一種實現方式，使用 `void` 作為其餘鍵的類型\n *\n * @example\n * interface User { name?: string; age?: number; }\n * type OnlyOne1 = ITSRequireOnlyOne<User, 'name' | 'age'>;\n * // 輸出結果：\n * // type OnlyOne1 = { name: string; age?: never; } | { age: number; name?: never; }\n * // 只能提供 name 或 age 其中一個，不能同時提供\n */\nexport type ITSRequireOnlyOne<T, Keys extends keyof T = keyof T> =\n\tOmit<T, Keys>\n\t& {\n\t[K in Keys]-?: ITSRequiredPick<T, K>\n\t& Partial<Record<Exclude<Keys, K>, never>>\n}[Keys];\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-type",
-  "version": "3.0.7",
+  "version": "3.0.10",
   "description": "TypeScript 類型工具庫：提供豐富的類型操作工具和重新導出的內建類型 / TypeScript type utility library: provides rich type manipulation utilities and re-exported built-in types",
   "keywords": [
     ".d.ts",
@@ -97,5 +97,5 @@
   "peerDependencies": {
     "ts-toolbelt": "^9.6.0"
   },
-  "gitHead": "fa1d461d70669aad17f322801a5fde844b2e0c73"
+  "gitHead": "c87f657dc8050a9b9c3ed646262f6c497a867f05"
 }