实用程序类型

TypeScript 提供了多种实用程序类型来促进常见的类型转换。这些实用程序在全球范围内可用。

Awaited<Type>

发布： 4.5

这种类型旨在对函数await中的async操作或 s.then()上的方法进行建模 - 具体来说，是它们递归解开sPromise的方式。Promise

例子

type A = Awaited<Promise<string>>; // type A = string

type B = Awaited<Promise<Promise<number>>>; // type B = number

type C = Awaited<boolean | Promise<number>>; // type C = number | boolean

Partial<Type>

发布： 2.1

构造一个类型，并将所有属性Type设置为可选。该实用程序将返回一个表示给定类型的所有子集的类型。

例子

interface Todo {
  title: string;
  description: string;
}

function updateTodo(todo: Todo, fieldsToUpdate: Partial<Todo>) {
  return {...todo, ...fieldsToUpdate};
}

const todo1 = {
  title: "organize desk",
  description: "clear clutter",
};

const todo2 = updateTodo(todo1, {
  description: "throw out trash",
});

Required<Type>

发布： 2.8

Type构造一个由设置为 required 的所有属性组成的类型。的相反Partial。

例子

interface Props {
  a?: number;
  b?: string;
}

const obj: Props = {a: 5};

const obj2: Required<Props> = {a: 5};
// Property 'b' is missing in type '{ a: number; }' but required in type 'Required<Props>'.

Readonly<Type>

发布： 2.1

构造一个类型，并将所有属性Type设置为readonly，这意味着构造类型的属性不能重新分配。

例子

interface Todo {
  title: string;
}

const todo: Readonly<Todo> = {
  title: "Delete inactive users",
};

todo.title = "Hello"; // Cannot assign to 'title' because it is a read-only property.

该实用程序对于表示在运行时失败的赋值表达式非常有用（即，当尝试重新分配冻结对象的属性时）。

Object.freeze

function freeze<Type>(obj: Type): Readonly<Type>;

Record<Keys, Type>

发布： 2.1

构造一个对象类型，其属性键为Keys，属性值为Type。该实用程序可用于将一种类型的属性映射到另一种类型。

例子

interface CatInfo {
  age: number;
  breed: string;
}

type CatName = "miffy" | "boris" | "mordred";

const cats: Record<CatName, CatInfo> = {
  miffy: {age: 10, breed: "Persian"},
  boris: {age: 5, breed: "Maine Coon"},
  mordred: {age: 16, breed: "British Shorthair"},
};

cats.boris; // const cats: Record<CatName, CatInfo>

Pick<Type, Keys>

发布： 2.1

通过从 中选取属性集Keys（字符串文字或字符串文字的并集）来构造类型Type。

例子

interface Todo {
  title: string;
  description: string;
  completed: boolean;
}

type TodoPreview = Pick<Todo, "title" | "completed">;

const todo: TodoPreview = {
  title: "Clean room",
  completed: false,
};

todo; // const todo: TodoPreview

Omit<Type, Keys>

发布： 3.5

Type通过从中选取所有属性然后删除Keys（字符串文字或字符串文字的并集）来构造类型。的相反Pick。

例子

interface Todo {
  title: string;
  description: string;
  completed: boolean;
  createdAt: number;
}

type TodoPreview = Omit<Todo, "description">;

const todo: TodoPreview = {
  title: "Clean room",
  completed: false,
  createdAt: 1615544252770,
};

todo; // const todo: TodoPreview

type TodoInfo = Omit<Todo, "completed" | "createdAt">;

const todoInfo: TodoInfo = {
  title: "Pick up kids",
  description: "Kindergarten closes at 5pm",
};

todoInfo; // const todoInfo: TodoInfo

Exclude<UnionType, ExcludedMembers>

发布： 2.8

UnionType通过排除所有可分配给 的联合成员来构造类型ExcludedMembers。

例子

type T0 = Exclude<"a" | "b" | "c", "a">; // type T0 = "b" | "c"

type T1 = Exclude<"a" | "b" | "c", "a" | "b">; // type T1 = "c"

type T2 = Exclude<string | number | (() => void), Function>; // type T2 = string | number

type Shape = {kind: "circle"; radius: number} | {kind: "square"; x: number} | {kind: "triangle"; x: number; y: number};

type T3 = Exclude<Shape, {kind: "circle"}>;
/*
type T3 = {
    kind: "square";
    x: number;
} | {
    kind: "triangle";
    x: number;
    y: number;
}
*/

Extract<Type, Union>

发布： 2.8

Type通过从可分配给 的所有联合成员中提取来构造类型Union。

例子

type T0 = Extract<"a" | "b" | "c", "a" | "f">; // type T0 = "a"

type T1 = Extract<string | number | (() => void), Function>; // type T1 = () => void

type Shape = {kind: "circle"; radius: number} | {kind: "square"; x: number} | {kind: "triangle"; x: number; y: number};

type T2 = Extract<Shape, {kind: "circle"}>;
/*
type T2 = {
    kind: "circle";
    radius: number;
}
*/

NonNullable<Type>

发布： 2.8

null通过排除和undefinedfrom构造类型Type。

例子

type T0 = NonNullable<string | number | undefined>; // type T0 = string | number

type T1 = NonNullable<string[] | null | undefined>; // type T1 = string[]

Parameters<Type>

发布： 3.1

根据函数类型的参数中使用的类型构造元组类型Type。

例子

declare function f1(arg: {a: number; b: string}): void;

type T0 = Parameters<() => string>; // type T0 = []

type T1 = Parameters<(s: string) => void>; // type T1 = [s: string]

type T2 = Parameters<<T>(arg: T) => T>; // type T2 = [arg: unknown]

type T3 = Parameters<typeof f1>;

/*
type T3 = [arg: {
  a: number;
  b: string;
}]
*/
type T4 = Parameters<any>;

type T4 = unknown[];
type T5 = Parameters<never>;

type T5 = never;
type T6 = Parameters<string>;
// Type 'string' does not satisfy the constraint '(...args: any) => any'.

type T6 = never;
type T7 = Parameters<Function>;
// Type 'Function' does not satisfy the constraint '(...args: any) => any'.
// Type 'Function' provides no match for the signature '(...args: any): any'.

type T7 = never;

ConstructorParameters<Type>

发布： 3.1

从构造函数类型的类型构造元组或数组类型。它生成一个包含所有参数类型的元组类型（或者never如果Type不是函数则为该类型）。

例子

type T0 = ConstructorParameters<ErrorConstructor>; // type T0 = [message?: string]

type T1 = ConstructorParameters<FunctionConstructor>; // type T1 = string[]

type T2 = ConstructorParameters<RegExpConstructor>; // type T2 = [pattern: string | RegExp, flags?: string]

class C {
  constructor(a: number, b: string) {}
}

type T3 = ConstructorParameters<typeof C>; // type T3 = [a: number, b: string]

type T4 = ConstructorParameters<any>; // type T4 = unknown[]

type T5 = ConstructorParameters<Function>;
// Type 'Function' does not satisfy the constraint 'abstract new (...args: any) => any'.
// Type 'Function' provides no match for the signature 'new (...args: any): any'.
// type T5 = never

ReturnType<Type>

发布： 2.8

构造一个由 function 的返回类型组成的类型Type。

例子

declare function f1(): {a: number; b: string};

type T0 = ReturnType<() => string>; // type T0 = string

type T1 = ReturnType<(s: string) => void>; // type T1 = void

type T2 = ReturnType<<T>() => T>; // type T2 = unknown

type T3 = ReturnType<<T extends U, U extends number[]>() => T>; // type T3 = number[]

type T4 = ReturnType<typeof f1>;
/*
type T4 = {
  a: number;
  b: string;
}
*/

type T5 = ReturnType<any>; // type T5 = any

type T6 = ReturnType<never>; // type T6 = never

type T7 = ReturnType<string>;
// Type 'string' does not satisfy the constraint '(...args: any) => any'.
// type T7 = any

type T8 = ReturnType<Function>;
// Type 'Function' does not satisfy the constraint '(...args: any) => any'.
// Type 'Function' provides no match for the signature '(...args: any): any'.
// type T8 = any

InstanceType<Type>

发布： 2.8

构造一个由 中构造函数的实例类型组成的类型Type。

例子

class C {
  x = 0;
  y = 0;
}

type T0 = InstanceType<typeof C>; // type T0 = C

type T1 = InstanceType<any>; // type T1 = any

type T2 = InstanceType<never>; // type T2 = never

type T3 = InstanceType<string>;
// Type 'string' does not satisfy the constraint 'abstract new (...args: any) => any'.
// type T3 = any

type T4 = InstanceType<Function>;
// Type 'Function' does not satisfy the constraint 'abstract new (...args: any) => any'.
// Type 'Function' provides no match for the signature 'new (...args: any): any'.
// type T4 = any

ThisParameterType<Type>

发布： 3.3

提取函数类型的this参数的类型，如果函数类型没有参数，则提取未知this。

例子

function toHex(this: Number) {
  return this.toString(16);
}

function numberToString(n: ThisParameterType<typeof toHex>) {
  return toHex.apply(n);
}

OmitThisParameter<Type>

发布： 3.3

this从 中删除参数Type。如果Type没有显式声明的this参数，则结果只是Type。this否则，将从 中创建一个不带参数的新函数类型Type。泛型被删除，只有最后一个重载签名被传播到新的函数类型中。

例子

function toHex(this: Number) {
  return this.toString(16);
}

const fiveToHex: OmitThisParameter<typeof toHex> = toHex.bind(5);

console.log(fiveToHex());

ThisType<Type>

发布： 2.3

此实用程序不返回转换后的类型。相反，它充当上下文类型的标记this。noImplicitThis请注意，必须启用该标志才能使用此实用程序。

例子

type ObjectDescriptor<D, M> = {
  data?: D;
  methods?: M & ThisType<D & M>; // Type of 'this' in methods is D & M
};

function makeObject<D, M>(desc: ObjectDescriptor<D, M>): D & M {
  let data: object = desc.data || {};
  let methods: object = desc.methods || {};
  return {...data, ...methods} as D & M;
}

let obj = makeObject({
  data: {x: 0, y: 0},
  methods: {
    moveBy(dx: number, dy: number) {
      this.x += dx; // Strongly typed this
      this.y += dy; // Strongly typed this
    },
  },
});

obj.x = 10;
obj.y = 20;
obj.moveBy(5, 5);

在上面的示例中，methods参数 to 中的对象makeObject具有包含的上下文类型，因此对象内方法中的thisThisType<D & M>类型为。请注意属性的类型如何同时成为推理目标和方法中类型的源。methods``{ 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 包含一组可用于类型系统中的字符串操作的类型。您可以在模板文字类型文档中找到它们。

在本页

• 等待<类型>
• 部分<类型>
• 必填<类型>
• 只读<类型>
• 记录<键，类型>
• 选择<类型，键>
• 省略<类型、键>
• 排除
• 提取<类型，联合>
• 不可空<类型>
• 参数<类型>
• 构造函数参数<类型>
• 返回类型<类型>
• 实例类型<类型>
• 此参数类型<类型>
• 省略此参数<类型>
• 此类型<类型>
• 固有字符串操作类型
• 大写<字符串类型>
• 小写<字符串类型>
• 大写<字符串类型>
• 取消大写