TypeScript 提供了几种实用工具类型,以便于进行常见的类型转换。这些工具类型全局可用。
Awaited<Type>
发布于:4.5
此类型旨在为如下操作建模:async 函数中的 await,或 Promise 上的 .then() 方法——具体来说,就是它们递归解包 Promise 的方式。
示例
tsTrytypeA =Awaited <Promise <string>>;typeB =Awaited <Promise <Promise <number>>>;typeC =Awaited <boolean |Promise <number>>;
Partial<Type>
发布于:
2.1
构造一个类型,将 Type 的所有属性设置为可选。此工具类型将返回一个表示给定类型的所有子集的类型。
示例
tsTryinterfaceTodo {title : string;description : string;}functionupdateTodo (todo :Todo ,fieldsToUpdate :Partial <Todo >) {return { ...todo , ...fieldsToUpdate };}consttodo1 = {title : "organize desk",description : "clear clutter",};consttodo2 =updateTodo (todo1 , {description : "throw out trash",});
Required<Type>
发布于:
2.8
构造一个类型,将 Type 的所有属性设置为必需。它是 Partial 的反面。
示例
tsTryinterfaceProps {a ?: number;b ?: string;}constobj :Props = {a : 5 };constProperty 'b' is missing in type '{ a: number; }' but required in type 'Required<Props>'.2741Property 'b' is missing in type '{ a: number; }' but required in type 'Required<Props>'.: obj2 Required <Props > = {a : 5 };
Readonly<Type>
发布于:
2.1
构造一个类型,将 Type 的所有属性设置为 readonly,这意味着构造出的类型的属性无法重新赋值。
示例
tsTryinterfaceTodo {title : string;}consttodo :Readonly <Todo > = {title : "Delete inactive users",};Cannot assign to 'title' because it is a read-only property.2540Cannot assign to 'title' because it is a read-only property.todo .= "Hello"; title
此工具类型适合用来表示那些会在运行时失败的赋值表达式(即尝试重新赋值冻结对象的属性时)。
Object.freeze
tsfunction freeze<Type>(obj: Type): Readonly<Type>;
Record<Keys, Type>
发布于:
2.1
构造一个对象类型,其属性键为 Keys,属性值为 Type。此工具类型可用于将一个类型的属性映射到另一个类型。
示例
tsTrytypeCatName = "miffy" | "boris" | "mordred";interfaceCatInfo {age : number;breed : string;}constcats :Record <CatName ,CatInfo > = {miffy : {age : 10,breed : "Persian" },boris : {age : 5,breed : "Maine Coon" },mordred : {age : 16,breed : "British Shorthair" },};cats .boris ;
Pick<Type, Keys>
发布于:
2.1
通过从 Type 中选取一组属性 Keys(字符串字面量或字符串字面量的联合)来构造一个类型。
示例
tsTryinterfaceTodo {title : string;description : string;completed : boolean;}typeTodoPreview =Pick <Todo , "title" | "completed">;consttodo :TodoPreview = {title : "Clean room",completed : false,};todo ;
Omit<Type, Keys>
发布于:
3.5
通过从 Type 中选取所有属性、再移除 Keys(字符串字面量或字符串字面量的联合)来构造一个类型。它是 Pick 的反面。
示例
tsTryinterfaceTodo {title : string;description : string;completed : boolean;createdAt : number;}typeTodoPreview =Omit <Todo , "description">;consttodo :TodoPreview = {title : "Clean room",completed : false,createdAt : 1615544252770,};todo ;typeTodoInfo =Omit <Todo , "completed" | "createdAt">;consttodoInfo :TodoInfo = {title : "Pick up kids",description : "Kindergarten closes at 5pm",};todoInfo ;
Exclude<UnionType, ExcludedMembers>
发布于:
2.8
通过从 UnionType 中排除所有可赋值给 ExcludedMembers 的联合成员来构造一个类型。
示例
tsTrytypeT0 =Exclude <"a" | "b" | "c", "a">;typeT1 =Exclude <"a" | "b" | "c", "a" | "b">;typeT2 =Exclude <string | number | (() => void),Function >;typeShape =| {kind : "circle";radius : number }| {kind : "square";x : number }| {kind : "triangle";x : number;y : number };typeT3 =Exclude <Shape , {kind : "circle" }>
Extract<Type, Union>
发布于:
2.8
通过从 Type 中提取所有可赋值给 Union 的联合成员来构造一个类型。
示例
tsTrytypeT0 =Extract <"a" | "b" | "c", "a" | "f">;typeT1 =Extract <string | number | (() => void),Function >;typeShape =| {kind : "circle";radius : number }| {kind : "square";x : number }| {kind : "triangle";x : number;y : number };typeT2 =Extract <Shape , {kind : "circle" }>
NonNullable<Type>
发布于:
2.8
通过从 Type 中排除 null 和 undefined 来构造一个类型。
示例
tsTrytypeT0 =NonNullable <string | number | undefined>;typeT1 =NonNullable <string[] | null | undefined>;
Parameters<Type>
发布于:
3.1
从函数类型 Type 的参数所使用的类型中构造一个元组类型。
对于重载函数,此处取最后一个签名的参数;参见在条件类型中进行推断。
示例
tsTrydeclare functionf1 (arg : {a : number;b : string }): void;typeT0 =Parameters <() => string>;typeT1 =Parameters <(s : string) => void>;typeT2 =Parameters <<T >(arg :T ) =>T >;typeT3 =Parameters <typeoff1 >;typeT4 =Parameters <any>;typeT5 =Parameters <never>;typeType 'string' does not satisfy the constraint '(...args: any) => any'.2344Type 'string' does not satisfy the constraint '(...args: any) => any'.T6 =Parameters <string >;typeType 'Function' does not satisfy the constraint '(...args: any) => any'. Type 'Function' provides no match for the signature '(...args: any): any'.2344Type 'Function' does not satisfy the constraint '(...args: any) => any'. Type 'Function' provides no match for the signature '(...args: any): any'.T7 =Parameters <>; Function
ConstructorParameters<Type>
发布于:
3.1
从构造函数类型构造一个元组或数组类型。它会生成一个包含所有参数类型的元组类型(如果 Type 不是函数,则为 never 类型)。
示例
tsTrytypeT0 =ConstructorParameters <ErrorConstructor >;typeT1 =ConstructorParameters <FunctionConstructor >;typeT2 =ConstructorParameters <RegExpConstructor >;classC {constructor(a : number,b : string) {}}typeT3 =ConstructorParameters <typeofC >;typeT4 =ConstructorParameters <any>;typeType 'Function' does not satisfy the constraint 'abstract new (...args: any) => any'. Type 'Function' provides no match for the signature 'new (...args: any): any'.2344Type 'Function' does not satisfy the constraint 'abstract new (...args: any) => any'. Type 'Function' provides no match for the signature 'new (...args: any): any'.T5 =ConstructorParameters <>; Function
ReturnType<Type>
发布于:
2.8
构造一个类型,由函数 Type 的返回类型组成。
对于重载函数,此处取最后一个签名的返回类型;参见在条件类型中进行推断。
示例
tsTrydeclare functionf1 (): {a : number;b : string };typeT0 =ReturnType <() => string>;typeT1 =ReturnType <(s : string) => void>;typeT2 =ReturnType <<T >() =>T >;typeT3 =ReturnType <<T extendsU ,U extends number[]>() =>T >;typeT4 =ReturnType <typeoff1 >;typeT5 =ReturnType <any>;typeT6 =ReturnType <never>;typeType 'string' does not satisfy the constraint '(...args: any) => any'.2344Type 'string' does not satisfy the constraint '(...args: any) => any'.T7 =ReturnType <string >;typeType 'Function' does not satisfy the constraint '(...args: any) => any'. Type 'Function' provides no match for the signature '(...args: any): any'.2344Type 'Function' does not satisfy the constraint '(...args: any) => any'. Type 'Function' provides no match for the signature '(...args: any): any'.T8 =ReturnType <>; Function
InstanceType<Type>
发布于:
2.8
构造一个类型,由 Type 中构造函数的实例类型组成。
示例
tsTryclassC {x = 0;y = 0;}typeT0 =InstanceType <typeofC >;typeT1 =InstanceType <any>;typeT2 =InstanceType <never>;typeType 'string' does not satisfy the constraint 'abstract new (...args: any) => any'.2344Type 'string' does not satisfy the constraint 'abstract new (...args: any) => any'.T3 =InstanceType <string >;typeType 'Function' does not satisfy the constraint 'abstract new (...args: any) => any'. Type 'Function' provides no match for the signature 'new (...args: any): any'.2344Type 'Function' does not satisfy the constraint 'abstract new (...args: any) => any'. Type 'Function' provides no match for the signature 'new (...args: any): any'.T4 =InstanceType <>; Function
NoInfer<Type>
发布于:
5.4
阻止对所含类型的推断。除阻止推断之外,NoInfer<Type> 与 Type 完全相同。
示例
tsfunction createStreetLight<C extends string>(colors: C[],defaultColor?: NoInfer<C>,) {// ...}createStreetLight(["red", "yellow", "green"], "red"); // OKcreateStreetLight(["red", "yellow", "green"], "blue"); // Error
ThisParameterType<Type>
发布于:
3.3
提取函数类型的 this 参数的类型;如果该函数类型没有 this 参数,则为 unknown。
示例
tsTryfunctiontoHex (this :Number ) {return this.toString (16);}functionnumberToString (n :ThisParameterType <typeoftoHex >) {returntoHex .apply (n );}
OmitThisParameter<Type>
发布于:
3.3
从 Type 中移除 this 参数。如果 Type 没有显式声明 this 参数,结果就是 Type 本身。否则,会基于 Type 创建一个没有 this 参数的新函数类型。泛型会被擦除,只有最后一个重载签名会传播到新函数类型中。
示例
tsTryfunctiontoHex (this :Number ) {return this.toString (16);}constfiveToHex :OmitThisParameter <typeoftoHex > =toHex .bind (5);console .log (fiveToHex ());
ThisType<Type>
发布于:
2.3
此工具类型不会返回转换后的类型。相反,它用作上下文 this 类型的标记。注意,使用此工具类型必须启用 noImplicitThis 标志。
示例
tsTrytypeObjectDescriptor <D ,M > = {data ?:D ;methods ?:M &ThisType <D &M >; // Type of 'this' in methods is D & M};functionmakeObject <D ,M >(desc :ObjectDescriptor <D ,M >):D &M {letdata : object =desc .data || {};letmethods : object =desc .methods || {};return { ...data , ...methods } asD &M ;}letobj =makeObject ({data : {x : 0,y : 0 },methods : {moveBy (dx : number,dy : number) {this.x +=dx ; // Strongly typed thisthis.y +=dy ; // Strongly typed this},},});obj .x = 10;obj .y = 20;obj .moveBy (5, 5);
在上面的示例中,makeObject 的参数里的 methods 对象具有包含 ThisType<D & M> 的上下文类型,因此 methods 对象内各方法中 this 的类型为 { x: number, y: number } & { moveBy(dx: number, dy: number): void }。请注意,methods 属性的类型同时既是推断目标,又是各方法中 this 类型的来源。
ThisType<T> 标记接口只是 lib.d.ts 中声明的一个空接口。除了能在对象字面量的上下文类型中被识别之外,该接口的行为与任何空接口无异。
内置字符串操作类型
Uppercase<StringType>
Lowercase<StringType>
Capitalize<StringType>
Uncapitalize<StringType>
为了便于围绕模板字符串字面量进行字符串处理,TypeScript 包含一组可在类型系统内用于字符串处理的类型。你可以在模板字面量类型文档中找到它们。