首页
/ 深入理解type-fest中的OptionalExcept类型工具

深入理解type-fest中的OptionalExcept类型工具

2025-05-15 20:42:17作者:蔡丛锟

在TypeScript开发中,我们经常需要对对象类型进行部分可选化的处理。type-fest库提供了一系列实用的类型工具,其中SetOptional类型允许我们将对象类型的某些属性标记为可选。然而,在实际开发中,我们有时会遇到相反的需求:保留某些属性为必选,而将其余属性设为可选。

核心问题

假设我们有一个User接口:

interface User {
  username: string;
  isAdmin: boolean;
  dateCreated: Date;
}

我们想要创建一个类型,其中username保持必选,而其他属性变为可选。这在创建新用户时特别有用,因为username通常是必填项,而其他属性可以有默认值。

解决方案

type-fest虽然没有直接提供OptionalExcept类型,但我们可以通过组合现有的类型工具来实现相同的功能:

type OptionalExcept<T, K extends keyof T> = Pick<T, K> & Partial<Omit<T, K>>;

或者使用type-fest提供的SetOptional:

SetOptional<User, Exclude<keyof User, 'username'>>

这两种方法都能实现相同的效果:保留指定属性为必选,其他属性变为可选。

实际应用

让我们看一个实际应用的例子:

function createUser(options: OptionalExcept<User, 'username'>): User {
  return {
    isAdmin: false,             // 默认值
    dateCreated: new Date(),    // 默认值
    ...options                 // 用户提供的值(username必填)
  };
}

// 正确用法
createUser({ username: 'john' });

// 错误用法 - 缺少必填的username
createUser({ isAdmin: true });

技术解析

  1. Pick<T, K>:从类型T中选择属性K,保持它们的原始类型不变
  2. Omit<T, K>:从类型T中排除属性K,得到剩余属性的类型
  3. Partial:将类型T的所有属性变为可选
  4. &:交叉类型,合并两个类型的属性

通过组合这些基础类型操作,我们实现了保留部分属性必选,其余可选的高级类型操作。

最佳实践

  1. 当需要保留少量属性为必选时,使用OptionalExcept模式更直观
  2. 当需要将大量属性设为可选时,使用SetOptional更简洁
  3. 考虑在项目中统一这类工具类型的命名和使用方式,提高代码一致性

总结

TypeScript的类型系统非常强大,通过组合基础类型操作,我们可以创建出满足各种复杂需求的类型工具。理解这些类型操作的原理,能够帮助我们更灵活地处理各种类型转换场景,提高代码的类型安全性和开发效率。type-fest库提供了丰富的类型工具,合理利用这些工具可以大大提升我们的开发体验。

登录后查看全文
热门项目推荐
相关项目推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
163
2.05 K
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
199
279
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
60
16
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
952
558
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
96
15
apintoapinto
基于golang开发的网关。具有各种插件,可以自行扩展,即插即用。此外,它可以快速帮助企业管理API服务,提高API服务的稳定性和安全性。
Go
22
0
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Python
77
71
giteagitea
喝着茶写代码!最易用的自托管一站式代码托管平台,包含Git托管,代码审查,团队协作,软件包和CI/CD。
Go
17
0