首页
/ Type-Fest 中 RequireAllOrNone 类型工具的可选参数优化

Type-Fest 中 RequireAllOrNone 类型工具的可选参数优化

2025-05-15 16:54:52作者:戚魁泉Nursing

Type-Fest 是一个广受欢迎的 TypeScript 类型工具库,提供了许多实用的高级类型工具。其中 RequireAllOrNone 是一个非常有用的类型工具,它能够强制一个对象类型要么包含所有指定的属性,要么不包含任何指定的属性。

RequireAllOrNone 的基本功能

RequireAllOrNone 类型工具的主要作用是创建一个类型,该类型要求对象要么包含所有指定的属性,要么不包含任何指定的属性。这在处理可选属性组时特别有用,可以避免出现部分属性存在而部分属性缺失的中间状态。

原始的定义形式如下:

type RequireAllOrNone<T, K extends keyof T = never>

当前实现的问题

当前的实现要求必须提供第二个类型参数 K,即需要"全有或全无"的属性键集合。然而在实际使用中,开发者经常需要针对类型 T 的所有属性应用这一约束。

例如,当开发者想要一个类型的所有属性都遵循"全有或全无"规则时,不得不显式地写出:

type MyType = RequireAllOrNone<MyType, keyof MyType>

这显得不够简洁,也增加了使用时的认知负担。

改进方案

社区提出的改进方案是让第二个参数 K 成为可选参数,当不提供时,默认使用 keyof T 作为默认值。这样:

type MyType = RequireAllOrNone<MyType>

将等价于:

type MyType = RequireAllOrNone<MyType, keyof MyType>

这种改进符合 TypeScript 的类型工具设计惯例,也使 API 更加友好和一致。Type-Fest 中的其他类似类型工具(如 RequireAtLeastOneRequireExactlyOne 等)大多已经采用了这种可选参数的实现方式。

技术实现细节

要实现这一改进,需要修改类型定义为:

type RequireAllOrNone<T, K extends keyof T = keyof T>

这种修改是向后兼容的,不会影响现有代码。当开发者需要指定特定的属性子集时,仍然可以显式提供第二个参数;当需要针对所有属性时,则可以省略第二个参数。

实际应用场景

这种改进在实际开发中有多种应用场景:

  1. 配置对象类型:当定义一个配置对象类型时,可能希望某些相关配置项要么全部提供,要么全部不提供。

  2. API 响应类型:在处理 API 响应时,某些字段可能作为一组出现或完全不出现。

  3. 表单数据类型:在表单处理中,某些字段组可能需要整体存在或不存在。

改进后的 RequireAllOrNone 使这些场景的类型定义更加简洁明了。

总结

Type-Fest 库对 RequireAllOrNone 类型的这一改进,体现了 TypeScript 类型工具设计的实用性和一致性原则。通过使第二个参数可选,不仅提高了 API 的易用性,也保持了与其他类似类型工具的一致性。这种改进虽然看似微小,但对于提升开发者体验和代码可读性有着实际的价值。

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

项目优选

收起
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