实用工具类型
Partial<T>
,TypeScript 2.1Record<K,T>
,TypeScript 2.1Omit<T,K>
Extract<T,U>
,TypeScript 2.8InstanceType<T>
,TypeScript 2.8ThisType<T>
,TypeScript 2.8
Partial<T>
构造类型T
,并将它所有的属性设置为可选的。它的返回类型表示输入类型的所有子类型。
Readonly<T>
构造类型T
,并将它所有的属性设置为readonly
,也就是说构造出的类型的属性不能被再次赋值。
例子
interface Todo {
title: string;
}
const todo: Readonly<Todo> = {
title: 'Delete inactive users',
};
todo.title = 'Hello'; // Error: cannot reassign a readonly property
这个工具可用来表示在运行时会失败的赋值表达式(比如,当尝试给冻结对象的属性再次赋值时)。
Object.freeze
function freeze<T>(obj: T): Readonly<T>;
Record<K,T>
构造一个类型,其属性名的类型为K
,属性值的类型为T
。这个工具可用来将某个类型的属性映射到另一个类型上。
例子
title: string;
}
type Page = 'home' | 'about' | 'contact';
const x: Record<Page, PageInfo> = {
about: { title: 'about' },
contact: { title: 'contact' },
home: { title: 'home' },
};
Omit<T,K>
从类型T
中获取所有属性,然后从中剔除K
属性后构造一个类型。
例子
interface Todo {
title: string;
description: string;
completed: boolean;
}
type TodoPreview = Omit<Todo, 'description'>;
title: 'Clean room',
completed: false,
};
Exclude<T,U>
从类型T
中剔除所有可以赋值给U
的属性,然后构造一个类型。
例子
type T0 = Exclude<"a" | "b" | "c", "a">; // "b" | "c"
type T1 = Exclude<"a" | "b" | "c", "a" | "b">; // "c"
type T2 = Exclude<string | number | (() => void), Function>; // string | number
Extract<T,U>
从类型T
中提取所有可以赋值给U
的类型,然后构造一个类型。
例子
type T0 = Extract<"a" | "b" | "c", "a" | "f">; // "a"
type T1 = Extract<string | number | (() => void), Function>; // () => void
从类型T
中剔除null
和undefined
,然后构造一个类型。
例子
type T0 = ReturnType<() => string>; // string
type T1 = ReturnType<(s: string) => void>; // void
type T2 = ReturnType<(<T>() => T)>; // {}
type T3 = ReturnType<(<T extends U, U extends number[]>() => T)>; // number[]
type T4 = ReturnType<typeof f1>; // { a: number, b: string }
type T5 = ReturnType<any>; // any
type T6 = ReturnType<never>; // any
type T7 = ReturnType<string>; // Error
type T8 = ReturnType<Function>; // Error
InstanceType<T>
由构造函数类型T
的实例类型构造一个类型。
例子
class C {
x = 0;
y = 0;
}
type T0 = InstanceType<typeof C>; // C
type T1 = InstanceType<any>; // any
type T2 = InstanceType<never>; // any
type T3 = InstanceType<string>; // Error
type T4 = InstanceType<Function>; // Error
Required<T>
构造一个类型,使类型T
的所有属性为required
。
例子
interface Props {
a?: number;
b?: string;
};
const obj: Props = { a: 5 }; // OK
const obj2: Required<Props> = { a: 5 }; // Error: property 'b' missing
这个工具不会返回一个转换后的类型。它做为上下文的this
类型的一个标记。注意,若想使用此类型,必须启用--noImplicitThis
。
上面例子中,makeObject
参数里的methods
对象具有一个上下文类型ThisType<D & M>
,因此methods
对象的方法里this
的类型为{ x: number, y: number } & { moveBy(dx: number, dy: number): number }
。