Valibot 项目新增 TypeScript 断言函数支持
2025-05-30 18:55:20作者:卓炯娓
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 的理由。
登录后查看全文
热门项目推荐
相关项目推荐
Kimi-K2.5Kimi K2.5 是一款开源的原生多模态智能体模型,它在 Kimi-K2-Base 的基础上,通过对约 15 万亿混合视觉和文本 tokens 进行持续预训练构建而成。该模型将视觉与语言理解、高级智能体能力、即时模式与思考模式,以及对话式与智能体范式无缝融合。Python00
GLM-4.7-FlashGLM-4.7-Flash 是一款 30B-A3B MoE 模型。作为 30B 级别中的佼佼者,GLM-4.7-Flash 为追求性能与效率平衡的轻量化部署提供了全新选择。Jinja00
new-apiAI模型聚合管理中转分发系统,一个应用管理您的所有AI模型,支持将多种大模型转为统一格式调用,支持OpenAI、Claude、Gemini等格式,可供个人或者企业内部管理与分发渠道使用。🍥 A Unified AI Model Management & Distribution System. Aggregate all your LLMs into one app and access them via an OpenAI-compatible API, with native support for Claude (Messages) and Gemini formats.JavaScript01
idea-claude-code-gui一个功能强大的 IntelliJ IDEA 插件,为开发者提供 Claude Code 和 OpenAI Codex 双 AI 工具的可视化操作界面,让 AI 辅助编程变得更加高效和直观。Java01
KuiklyUI基于KMP技术的高性能、全平台开发框架,具备统一代码库、极致易用性和动态灵活性。 Provide a high-performance, full-platform development framework with unified codebase, ultimate ease of use, and dynamic flexibility.Kotlin07
compass-metrics-modelMetrics model project for the OSS CompassPython00
项目优选
收起
deepin linux kernel
C
27
11
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
518
3.69 K
暂无简介
Dart
760
182
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
875
568
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
67
20
Ascend Extension for PyTorch
Python
321
371
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
12
1
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.05 K
522
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
334
160
React Native鸿蒙化仓库
JavaScript
300
347