Valibot 项目新增 TypeScript 断言函数支持
2025-05-30 02:43:25作者:卓炯娓
Valibot 作为一款轻量级的 TypeScript 数据验证库,在最新发布的 v1.0.0-beta.1 版本中新增了一个非常实用的功能——assert 断言函数。这个功能的加入使得开发者能够更加优雅地进行类型收窄(Type Narrowing)和错误处理。
断言函数的作用
TypeScript 的断言函数是一种特殊类型的函数,它能够在运行时验证某个条件,并在条件不满足时抛出错误。如果条件满足,TypeScript 的类型系统会自动将变量的类型收窄为断言指定的类型。这种机制对于确保代码中变量的类型安全性非常有用。
在 Valibot 中,assert 函数本质上是对 parse 方法的包装,但它提供了更好的类型推断体验。开发者现在可以像下面这样使用:
function processInput(input: unknown) {
assert(v.string(), input); // 这里会进行类型收窄
return input.toUpperCase(); // 现在 TypeScript 知道 input 是 string 类型
}
实现原理
Valibot 的 assert 函数实现非常简洁但强大:
function assert<TSchema extends GenericSchema>(
schema: TSchema,
value: unknown,
config?: Config<InferIssue<TSchema>> | undefined
): asserts value is InferInput<TSchema> {
parse(schema, value, config);
}
这个实现有以下几个技术亮点:
- 泛型参数
TSchema确保了类型安全 asserts value is InferInput<TSchema>是 TypeScript 的断言签名- 内部直接调用
parse方法,保持了与 Valibot 核心验证逻辑的一致性
使用场景
这个功能特别适合以下场景:
- API 边界验证:在接收外部输入时立即验证并收窄类型
- 类型守卫:替代自定义的类型守卫函数,减少样板代码
- 错误处理:利用 Valibot 内置的错误消息机制,提供友好的验证失败反馈
最佳实践
在实际项目中,可以这样使用 assert 函数:
import { v, assert } from 'valibot';
const userSchema = v.object({
id: v.string(),
name: v.string(),
age: v.number(),
});
function saveUser(data: unknown) {
assert(userSchema, data); // 验证并收窄类型
// 现在 data 的类型已经被收窄为 { id: string; name: string; age: number }
db.users.insert(data);
}
总结
Valibot 新增的 assert 函数为 TypeScript 开发者提供了一个类型安全且简洁的数据验证方案。它结合了运行时验证和编译时类型检查的优势,使得代码更加健壮且易于维护。对于已经在使用 Valibot 的项目,这是一个值得立即采用的改进;对于新项目,这也增加了选择 Valibot 的理由。
登录后查看全文
热门项目推荐
相关项目推荐
kernelopenEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。C069
MiniMax-M2.1从多语言软件开发自动化到复杂多步骤办公流程执行,MiniMax-M2.1 助力开发者构建下一代自主应用——全程保持完全透明、可控且易于获取。Python00
kylin-wayland-compositorkylin-wayland-compositor或kylin-wlcom(以下简称kywc)是一个基于wlroots编写的wayland合成器。 目前积极开发中,并作为默认显示服务器随openKylin系统发布。 该项目使用开源协议GPL-1.0-or-later,项目中来源于其他开源项目的文件或代码片段遵守原开源协议要求。C01
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提供零码、低码可视化开发和工作流编排,模型、知识库、插件等各资源管理能力TSX0130
Spark-Formalizer-X1-7BSpark-Formalizer 是由科大讯飞团队开发的专用大型语言模型,专注于数学自动形式化任务。该模型擅长将自然语言数学问题转化为精确的 Lean4 形式化语句,在形式化语句生成方面达到了业界领先水平。Python00
项目优选
收起
deepin linux kernel
C
27
11
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
460
3.43 K
暂无简介
Dart
713
170
Ascend Extension for PyTorch
Python
267
304
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
186
68
React Native鸿蒙化仓库
JavaScript
284
332
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
841
417
openJiuwen agent-studio提供零码、低码可视化开发和工作流编排,模型、知识库、插件等各资源管理能力
TSX
434
130
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
10
1
华为昇腾面向大规模分布式训练的多模态大模型套件,支撑多模态生成、多模态理解。
Python
105
119