首页
/ Valibot 中处理 TypeScript 隔离声明的最佳实践

Valibot 中处理 TypeScript 隔离声明的最佳实践

2025-05-29 17:53:16作者:殷蕙予

在 TypeScript 5.5 中引入的隔离声明(isolatedDeclarations)功能要求开发者必须为变量显式添加类型注解。这对于使用 Valibot 这类 schema 验证库的开发者带来了一些挑战,特别是处理复杂 schema 时。

基本解决方案

Valibot 提供了 GenericSchema 类型,类似于 Zod 中的 ZodType,可以用来显式注解 schema 类型:

const LoginSchema: GenericSchema<{ email: string; password: string }> = v.object({
  email: v.pipe(v.string(), v.email()),
  password: v.pipe(v.string(), v.minLength(8)),
});

处理函数 schema 的特殊情况

当 schema 涉及函数验证时,情况会变得复杂。Valibot 的 v.function() 会生成 (...args: unknown[]) => unknown 类型,需要使用 GenericSchema 的第二个泛型参数来指定转换后的类型:

const argsFnSchema: GenericSchema<
  (...args: unknown[]) => unknown,
  (yourArg: number[]) => boolean
> = v.pipe(
  v.function(),
  v.args(v.tuple([v.array(v.number())])),
  v.returns(v.boolean())
);

复杂 schema 的处理策略

对于复杂的嵌套 schema,推荐先让 TypeScript 推断类型,再通过 InferInputInferOutput 工具类型获取类型定义:

const ComplexSchema = v.strictObject({
  // 复杂schema定义
});

type Input = InferInput<typeof ComplexSchema>;
type Output = InferOutput<typeof ComplexSchema>;

然后可以手动将这些类型复制到 GenericSchema 注解中。不过要注意,直接引用 schema 本身会导致循环类型引用错误。

实际开发建议

  1. 权衡利弊:虽然 GenericSchema 可以解决隔离声明的要求,但会丢失部分类型信息,可能影响后续的 schema 组合使用。

  2. 替代方案:考虑在项目配置中为 schema 文件禁用隔离声明规则,这可能是更简单的解决方案。

  3. 函数验证注意事项:使用函数验证时,确保正确使用 GenericSchema 的两个泛型参数,第一个是原始函数类型,第二个是转换后的类型。

Valibot 的设计哲学是尽可能保留完整的类型信息,因此在处理隔离声明需求时需要开发者做出适当权衡。随着 TypeScript 和 Valibot 的持续发展,未来可能会有更优雅的解决方案出现。

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

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
197
2.17 K
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
208
285
pytorchpytorch
Ascend Extension for PyTorch
Python
59
94
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
974
574
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1
ops-mathops-math
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
549
81
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
399
communitycommunity
本项目是CANN开源社区的核心管理仓库,包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息
393
27
MateChatMateChat
前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。 官网地址:https://matechat.gitcode.com
1.2 K
133