巧妙运用TypeScript中的Required和Exclude函数

2023-09-27 20:59:23

Required函数的妙用

Required函数的作用是将一个接口中所有非必填参数变为必填。它的语法非常简单：Required<T>，其中T代表要操作的接口。

举个例子，假设我们有一个接口Person，它定义了两个属性：name和age，其中name是必填的，而age是非必填的。

interface Person {
  name: string;
  age?: number;
}

如果我们想创建一个函数，要求传入一个Person对象，并且确保该对象中的name和age属性都存在，那么我们可以使用Required函数：

function greetPerson(person: Required<Person>) {
  console.log(`Hello, ${person.name}! You are ${person.age} years old.`);
}

const person1: Person = {
  name: 'John Doe',
  age: 30,
};

greetPerson(person1); // 输出: Hello, John Doe! You are 30 years old.

const person2: Partial<Person> = {
  name: 'Jane Doe',
};

greetPerson(person2); // 错误: Argument of type 'Partial<Person>' is not assignable to parameter of type 'Required<Person>'.

在上面的代码中，greetPerson函数要求传入一个Required<Person>类型的参数，这意味着该参数必须包含Person接口中定义的所有属性，包括必填属性和非必填属性。因此，当我们传入一个完整的Person对象时，函数可以正常工作，并输出问候语。但是，当我们传入一个不完整的Person对象时，函数就会报错，因为该对象缺少age属性。

Exclude函数的奥秘

Exclude函数的作用是将某个类型里的属性全部变为必选项。它的语法也非常简单：Exclude<T, U>，其中T代表要操作的类型，U代表要排除的类型。

举个例子，假设我们有一个类型Animal，它定义了两个属性：name和type，其中name是必填的，而type是非必填的。

type Animal = {
  name: string;
  type?: string;
};

如果我们想创建一个函数，要求传入一个Animal对象，并且确保该对象中的name属性存在，但type属性可以不存在，那么我们可以使用Exclude函数：

function getAnimalName(animal: Exclude<Animal, 'type'>) {
  return animal.name;
}

const animal1: Animal = {
  name: 'Dog',
  type: 'Mammal',
};

console.log(getAnimalName(animal1)); // 输出: Dog

const animal2: Partial<Animal> = {
  name: 'Cat',
};

console.log(getAnimalName(animal2)); // 输出: Cat

在上面的代码中，getAnimalName函数要求传入一个Exclude<Animal, 'type'>类型的参数，这意味着该参数必须包含Animal类型中定义的所有属性，但可以不包含type属性。因此，当我们传入一个完整的Animal对象时，函数可以正常工作，并输出动物的名称。当我们传入一个不完整的Animal对象时，函数也可以正常工作，并输出动物的名称。