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 返回的类型时。


相关文章
|
4天前
|
存储 安全 JavaScript
TypeScript-内置应用程序类型-Recode
通过使用 `Record` 类型,开发者可以显著提升代码的安全性和可维护性。无论是配置对象、字典结构还是动态表单,`Record` 类型都提供了一个简洁、类型安全的解决方案。
184 82
|
2月前
|
前端开发 JavaScript 开发者
前端项目代码规范工具 (ESLint. Prettier. Stylelint. TypeScript)
前端项目代码规范工具 (ESLint. Prettier. Stylelint. TypeScript)
141 4
|
3月前
|
设计模式 JavaScript 安全
TypeScript性能优化及代码质量提升的重要性、方法与策略,包括合理使用类型注解、减少类型断言、优化模块导入导出、遵循编码规范、加强代码注释等
本文深入探讨了TypeScript性能优化及代码质量提升的重要性、方法与策略,包括合理使用类型注解、减少类型断言、优化模块导入导出、遵循编码规范、加强代码注释等,旨在帮助开发者在保证代码质量的同时,实现高效的性能优化,提升用户体验和项目稳定性。
67 6
|
3月前
|
开发框架 JavaScript 前端开发
TypeScript 是一种静态类型的编程语言,它扩展了 JavaScript,为 Web 开发带来了强大的类型系统、组件化开发支持、与主流框架的无缝集成、大型项目管理能力和提升开发体验等多方面优势
TypeScript 是一种静态类型的编程语言,它扩展了 JavaScript,为 Web 开发带来了强大的类型系统、组件化开发支持、与主流框架的无缝集成、大型项目管理能力和提升开发体验等多方面优势。通过明确的类型定义,TypeScript 能够在编码阶段发现潜在错误,提高代码质量;支持组件的清晰定义与复用,增强代码的可维护性;与 React、Vue 等框架结合,提供更佳的开发体验;适用于大型项目,优化代码结构和性能。随着 Web 技术的发展,TypeScript 的应用前景广阔,将继续引领 Web 开发的新趋势。
60 2
|
3月前
|
JavaScript 安全 前端开发
TypeScript类型声明:基础与进阶
通过本文的介绍,我们详细探讨了TypeScript的基础与进阶类型声明。从基本数据类型到复杂的泛型和高级类型,TypeScript提供了丰富的工具来确保代码的类型安全和可维护性。掌握这些类型声明能够帮助开发者编写更加健壮和高效的代码,提高开发效率和代码质量。希望本文能为您在使用TypeScript时提供实用的参考和指导。
56 2
|
3月前
|
JavaScript 前端开发 安全
TypeScript进阶:类型系统与高级类型的应用
【10月更文挑战第25天】TypeScript作为JavaScript的超集,其类型系统是其核心特性之一。本文通过代码示例介绍了TypeScript的基本数据类型、联合类型、交叉类型、泛型和条件类型等高级类型的应用。这些特性不仅提高了代码的可读性和可维护性,还帮助开发者构建更健壮的应用程序。
45 0
|
5月前
|
JavaScript
typeScript进阶(9)_type类型别名
本文介绍了TypeScript中类型别名的概念和用法。类型别名使用`type`关键字定义,可以为现有类型起一个新的名字,使代码更加清晰易懂。文章通过具体示例展示了如何定义类型别名以及如何在函数中使用类型别名。
57 1
typeScript进阶(9)_type类型别名
|
4月前
|
JavaScript 前端开发 安全
深入理解TypeScript:增强JavaScript的类型安全性
【10月更文挑战第8天】深入理解TypeScript:增强JavaScript的类型安全性
80 0
|
4月前
|
JavaScript 前端开发 开发者
深入理解TypeScript:类型系统与实用技巧
【10月更文挑战第8天】深入理解TypeScript:类型系统与实用技巧
|
5月前
|
存储 JavaScript
typeScript进阶(11)_元组类型
本文介绍了TypeScript中的元组(Tuple)类型,它是一种特殊的数组类型,可以存储不同类型的元素。文章通过示例展示了如何声明元组类型以及如何给元组赋值。元组类型在定义时需要指定数组中每一项的类型,且在赋值时必须满足这些类型约束。此外,还探讨了如何给元组类型添加额外的元素,这些元素必须符合元组类型中定义的类型联合。
72 0