TypeScript 实用工具类型之 Omit 类型

简介: TypeScript 实用工具类型之 Omit 类型

TypeScript 实用工具类型之 Omit 类型

在本文中,我们将讨论 TypeScript 中使用 Omit<> 的对象类型转换。这是 TypeScript 实用工具类型系列的第二部分。

在上一篇文章(TypeScript 实用工具类型之 Pick 类型)中,我们介绍了一个例子,在这个例子中,我们通过 Pick<> 从基本类型 SuperbUser 中选择一些属性来派生一个 GuestUser 类型。之后暗示过,如果要选择的属性数量大于被丢弃的属性数量,那么选择就会变得不那么方便。在这种情况下,我们应该使用 Omit<>

在这篇文章中,我们将通过为 Subscriber 实体创建一个类型来考虑一个 Omit<> 的例子。

1. 示例

Pick<> 一样,Omit<> 接受基类型作为第一个参数,接受要省略的键的联合类型作为第二个参数,并返回排除这些属性的派生类型。

回过头来看 ERD,Subscriber 实体具有与 SuperbUser 相同的所有属性——除了 roles

5b0390e56d347e6c7ed02e29e2a22062.png

SuperbUser 派生 Subscriber 类型显然需要我们只忽略 roles 属性,而不是选择其他所有属性:

type SuperbUser = {
  userId: number,
  macAddress: string,
  username: string,
  email: string,
  password: string,
  firstName: string,
  lastName: string,
  roles: ('Admin' | 'Editor' | 'Author')[]
};
type Subscriber = Omit<SuperbUser, 'roles'>;

因此,在本例中,TypeScript 的 Omit<>Pick<> 更方便。我们现在可以创建一个 subscriber 对象,它的字段中删除了 roles 属性:

const subscriber: Subscriber = {
  userId: 4,
  macAddress: '132546',
  username: 'xiaan',
  email: 'xiaan@163.com',
  password: '12345678',
  firstName: 'an',
  lastName: 'xia'
};
console.log(subscriber);
/*
{
  "userId": 4,
  "macAddress": "132546",
  "username": "xiaan",
  "email": "xiaan@163.com",
  "password": "12345678",
  "firstName": "an",
  "lastName": "xia"
}
*/
console.log(subscriber.roles); // undefined

现在,让我们试着向 subscriber 添加 roles属性:

subscriber.roles = ['Reader', 'Commenter']; // Property 'roles' does not exist on type 'Subscriber'.
console.log(subscriber.roles); // ["Reader", "Commenter"]

TypeScript 抛出一个错误:

// Property 'roles' does not exist on type 'Subscriber'.

2. 应用于 Interface

就像在 Pick<> 中一样,我们可以使用 SuperbUser 的接口,结果是一样的:

interface SuperbUser {
  userId: number;
  macAddress: string;
  username: string;
  email: string;
  password: string;
  firstName: string;
  lastName: string;
  roles: ('Admin' | 'Editor' | 'Author')[]
};
type Subscriber = Omit<SuperbUser, 'roles'>;
const subscriber: Subscriber = {
  userId: 4,
  macAddress: '132546',
  username: 'xiaan',
  email: 'xiaan@163.com',
  password: '12345678',
  firstName: 'an',
  lastName: 'xia'
};
console.log(subscriber);
/*
{
  "userId": 4,
  "macAddress": "132546",
  "username": "xiaan",
  "email": "xiaan@163.com",
  "password": "12345678",
  "firstName": "an",
  "lastName": "xia"
}
*/
console.log(subscriber.roles); // undefined

3. 谨慎使用

Pick<> 一样,Typescript Omit 的第二个参数也接受键的并集。因此,如果需要省略任何其他属性,可以使用操作符 | 将它们添加到第二个参数中:

type Subscriber = Omit<SuperbUser, 'roles' | 'firstName' | ...>;

当需要省略的属性多于需要选取的属性时,应该避免使用 Omit<>,而使用 Pick<>

4. 小结

在本文中,我们通过一个示例深入研究了 Omit<>,该示例通过从基本类型 SuperbUser 中省略一个属性来为 Subscriber 实体派生一个类型。我们看到,Omit<>Pick<> 相反,当我们想从基类型中选取更多属性并较少省略时,Omit<> 更加方便。

在下一篇文章中,我们将介绍使用 Partial<type> 的对象类型转换。

相关文章
|
17天前
|
JavaScript 安全 前端开发
TypeScript类型声明:基础与进阶
通过本文的介绍,我们详细探讨了TypeScript的基础与进阶类型声明。从基本数据类型到复杂的泛型和高级类型,TypeScript提供了丰富的工具来确保代码的类型安全和可维护性。掌握这些类型声明能够帮助开发者编写更加健壮和高效的代码,提高开发效率和代码质量。希望本文能为您在使用TypeScript时提供实用的参考和指导。
30 2
|
1月前
|
JavaScript 开发者
在 Babel 插件中使用 TypeScript 类型
【10月更文挑战第23天】可以在 Babel 插件中更有效地使用 TypeScript 类型,提高插件的开发效率和质量,减少潜在的类型错误。同时,也有助于提升代码的可理解性和可维护性,使插件的功能更易于扩展和升级。
|
2月前
|
JavaScript 前端开发
TypeScript【类型别名、泛型】超简洁教程!再也不用看臭又长的TypeScript文档了!
【10月更文挑战第11天】TypeScript【类型别名、泛型】超简洁教程!再也不用看臭又长的TypeScript文档了!
|
2月前
|
JavaScript 前端开发 安全
TypeScript【基础类型】超简洁教程!再也不用看臭又长的TypeScript文档了!
【10月更文挑战第9天】TypeScript【基础类型】超简洁教程!再也不用看臭又长的TypeScript文档了!
|
2月前
|
JavaScript 前端开发 开发者
深入理解TypeScript:类型系统与最佳实践
【10月更文挑战第8天】深入理解TypeScript:类型系统与最佳实践
|
2月前
|
移动开发 JavaScript 前端开发
TypeScript:数组类型&函数使用&内置对象
本文介绍了 TypeScript 中的数组类型、对象数组、二维数组、函数、函数重载、内置对象等概念,并通过代码示例详细展示了它们的使用方法。还提供了一个使用 HTML5 Canvas 实现的下雨效果的小案例。
|
1月前
|
JavaScript 前端开发 安全
TypeScript进阶:类型系统与高级类型的应用
【10月更文挑战第25天】TypeScript作为JavaScript的超集,其类型系统是其核心特性之一。本文通过代码示例介绍了TypeScript的基本数据类型、联合类型、交叉类型、泛型和条件类型等高级类型的应用。这些特性不仅提高了代码的可读性和可维护性,还帮助开发者构建更健壮的应用程序。
27 0
|
3月前
|
JavaScript
typeScript进阶(9)_type类型别名
本文介绍了TypeScript中类型别名的概念和用法。类型别名使用`type`关键字定义,可以为现有类型起一个新的名字,使代码更加清晰易懂。文章通过具体示例展示了如何定义类型别名以及如何在函数中使用类型别名。
44 1
typeScript进阶(9)_type类型别名
|
3月前
|
JavaScript
typeScript基础(2)_any任意值类型和类型推论
本文介绍了TypeScript中的`any`任意值类型,它可以赋值为其他任何类型。同时,文章还解释了TypeScript中的类型推论机制,即在没有明确指定类型时,TypeScript如何根据变量的初始赋值来推断其类型。如果变量初始化时未指定类型,将被推断为`any`类型,从而允许赋予任何类型的值。
59 4
|
3月前
|
JavaScript
typeScript基础(5)_对象的类型-interfaces接口
本文介绍了TypeScript中接口(interfaces)的基本概念和用法,包括如何定义接口、接口的简单使用、自定义属性、以及如何使用`readonly`关键字定义只读属性。接口在TypeScript中是定义对象形状的重要方式,可以规定对象的必有属性、可选属性、自定义属性和只读属性。
43 1