TypeScript 实用工具类型之 Partial 类型

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

TypeScript 实用工具类型之 Partial 类型

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

在上一篇文章(TypeScript 实用工具类型之 Omit 类型),我们介绍了一个示例,在该示例中,我们通过省略基本类型 SuperbUser 的一个属性(使用Omit<>)来派生 Subscriber 类型。

在这篇文章中,我们将考虑一个 TypeScript Partial<> 的例子,通过修改我们的 Subscriber 类型来假设一个更现实的场景。

1. 场景概述

对于我们的博客,我们会有不允许点赞或评论文章的 GuestUser。我们将允许 Subscriber 点赞和评论。所以,情况是这样的:

  • GuestUser 必须用他们的 email 注册并成为 Subscriber
  • 他们会在发送到自己邮箱的 email 中收到设置 password 的链接。
  • 然后他们能够设置他们的 passwordfirstNamelastName

在这种情况下,我们之前派生的 Subscriber 类型不能以我们想要的方式交付我们的需求:

type Subscriber = {
  userId: number,
  macAddress: string,
  username: string,
  email: string,
  password: string,
  firstName: string,
  lastName: string,
};
const subscriber: Subscriber = {
  userId: 4,
  macAddress: '1.2.3',
  username: 'xiaan',
  email: 'xiaan@163.com'
};
console.log(subscriber);
/*
From TypeScript Error:
"Type '{ userId: number; macAddress: string; username: string; email: string; }' is missing the following properties from type 'Subscriber': password, firstName, lastName"
From console:
{
  "userId": 4,
  "macAddress": "1.2.3",
  "username": "xiaan",
  "email": "xiaan@163.com"
}
*/

TypeScript 指出 subscriberSubscriber 类型不一致。这是因为它默认将所有字段设置为必需的。如果我们设置 passwordfirstNamelastName 为可选,则不会报错:

type Subscriber = {
  userId: number,
  macAddress: string,
  username: string,
  email: string,
  password?: string,
  firstName?: string,
  lastName?: string,
};
const subscriber: Subscriber = {
  userId: 4,
  macAddress: '1.2.3',
  username: 'xiaan',
  email: 'xiaan@163.com'
};
console.log(subscriber);
/*
{
  "userId": 4,
  "macAddress": "1.2.3",
  "username": "xiaan",
  "email": "xiaan@163.com"
}
*/

但是这需要首先手动定义 Subscriber,然后再设置各个可选属性。在实际的 API 中,手动定义形状并不是一个好主意。

2. Partial

我们希望消除这种麻烦,并更轻松地从 Omit<> 返回的类型中完成此工作。所以我们要做的是用 Partial<type> 将返回类型的所有属性设置为可选的:

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

现在我们可以自由的为 passwordfirstNamelastName赋值。

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

但是,就像之前一样,如果我们添加了不属于 Subscriber 的属性,TypeScript 会再次报错:

subscriber.roles = ['Reader', 'Commenter'];
console.log(subscriber);
// Property 'roles' does not exist on type 'Partial<Omit<SuperbUser, "roles">>'.

因此,使用 TypeScript 派生 partial 类型的好处包括它对对象属性的部分赋值的支持,这是 JavaScript 允许的,而默认 TypeScript 不允许。

3. 使用 Interface

如果我们使用基本 SuperbUser 类型的接口,我们会得到相同的结果:

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

我们还可以将 Omit<> 的返回类型重构为中介类型 StrictSubscriber,并将其作为 TypeScript Partial 的参数传递:

type StrictSubscriber = Omit<SuperbUser, 'roles'>;
type Subscriber = Partial<StrictSubscriber>;

4. 小结

在这篇文章中,我们介绍了使用实用转换器 partial 的使用,不过手动将类型的某些属性设置为可选更可取,特别是在处理从 API 返回的类型时。


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