Type-Fest 中 RequireAllOrNone 类型工具的可选参数优化
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 中的其他类似类型工具(如 RequireAtLeastOne、RequireExactlyOne 等)大多已经采用了这种可选参数的实现方式。
技术实现细节
要实现这一改进,需要修改类型定义为:
type RequireAllOrNone<T, K extends keyof T = keyof T>
这种修改是向后兼容的,不会影响现有代码。当开发者需要指定特定的属性子集时,仍然可以显式提供第二个参数;当需要针对所有属性时,则可以省略第二个参数。
实际应用场景
这种改进在实际开发中有多种应用场景:
-
配置对象类型:当定义一个配置对象类型时,可能希望某些相关配置项要么全部提供,要么全部不提供。
-
API 响应类型:在处理 API 响应时,某些字段可能作为一组出现或完全不出现。
-
表单数据类型:在表单处理中,某些字段组可能需要整体存在或不存在。
改进后的 RequireAllOrNone 使这些场景的类型定义更加简洁明了。
总结
Type-Fest 库对 RequireAllOrNone 类型的这一改进,体现了 TypeScript 类型工具设计的实用性和一致性原则。通过使第二个参数可选,不仅提高了 API 的易用性,也保持了与其他类似类型工具的一致性。这种改进虽然看似微小,但对于提升开发者体验和代码可读性有着实际的价值。
kernelopenEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。C086
baihu-dataset异构数据集“白虎”正式开源——首批开放10w+条真实机器人动作数据,构建具身智能标准化训练基座。00
mindquantumMindQuantum is a general software library supporting the development of applications for quantum computation.Python057
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00
GLM-4.7GLM-4.7上线并开源。新版本面向Coding场景强化了编码能力、长程任务规划与工具协同,并在多项主流公开基准测试中取得开源模型中的领先表现。 目前,GLM-4.7已通过BigModel.cn提供API,并在z.ai全栈开发模式中上线Skills模块,支持多模态任务的统一规划与协作。Jinja00
agent-studioopenJiuwen agent-studio提供零码、低码可视化开发和工作流编排,模型、知识库、插件等各资源管理能力TSX0137
Spark-Formalizer-X1-7BSpark-Formalizer 是由科大讯飞团队开发的专用大型语言模型,专注于数学自动形式化任务。该模型擅长将自然语言数学问题转化为精确的 Lean4 形式化语句,在形式化语句生成方面达到了业界领先水平。Python00