首页
/ TypeBox中Value.Parse()与additionalProperties的注意事项

TypeBox中Value.Parse()与additionalProperties的注意事项

2025-06-06 22:48:32作者:瞿蔚英Wynne

TypeBox是一个用于TypeScript的运行时类型检查库,它允许开发者定义类型模式并在运行时验证数据。在使用过程中,开发者可能会遇到关于additionalProperties标志在Value.Parse()方法中表现不一致的问题。

问题背景

在TypeBox中,当定义一个对象模式时,可以通过设置additionalProperties: false来禁止对象包含模式定义之外的额外属性。这个设置在Value.Check()方法中能够正常工作,但在Value.Parse()方法中却不会抛出错误。

原因分析

实际上,这是TypeBox的预期行为。Value.Parse()方法内部实现了一个默认的处理管道,包含多个操作步骤:

  1. Clone - 克隆值
  2. Clean - 清理值(在此步骤中会移除额外属性)
  3. Default - 分配默认值
  4. Convert - 应用值强制转换
  5. Assert - 检查值是否正确
  6. Decode - 解码值

在Clean操作阶段,Value.Parse()会主动移除额外属性而不是抛出错误,这与Value.Check()的严格验证行为不同。

解决方案

如果开发者希望在解析过程中严格验证额外属性并抛出错误,可以自定义解析管道,省略Clean操作步骤:

const result = Value.Parse([
  'Clone',   // 克隆值
  // 'Clean', // 跳过清理步骤
  'Default', // 分配默认值
  'Convert', // 应用值强制转换
  'Assert',  // 检查值是否正确(此处会验证额外属性)
  'Decode'   // 解码值
], schema, value);

通过这种方式,当输入值包含模式定义之外的属性时,Assert操作会抛出错误,而不是静默地移除额外属性。

最佳实践

  1. 如果需要快速验证数据而不关心额外属性,使用默认的Value.Parse()
  2. 如果需要严格验证数据并确保没有额外属性,使用自定义管道或Value.Check()
  3. 在性能敏感场景中,Value.Check()通常比Value.Parse()更高效

理解TypeBox内部处理管道的设计理念,可以帮助开发者更灵活地选择适合自己需求的数据验证方式。

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

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
143
1.92 K
kernelkernel
deepin linux kernel
C
22
6
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++
192
274
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
929
553
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
422
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
65
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8