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 的易用性,也保持了与其他类似类型工具的一致性。这种改进虽然看似微小,但对于提升开发者体验和代码可读性有着实际的价值。
HunyuanImage-3.0
HunyuanImage-3.0 统一多模态理解与生成,基于自回归框架,实现文本生成图像,性能媲美或超越领先闭源模型00ops-transformer
本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。C++043Hunyuan3D-Part
腾讯混元3D-Part00GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~0289Hunyuan3D-Omni
腾讯混元3D-Omni:3D版ControlNet突破多模态控制,实现高精度3D资产生成00GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile09
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
热门内容推荐
最新内容推荐
项目优选









