Valibot 中如何提取 Schema 的元数据类型

在 TypeScript 开发中，我们经常需要从验证库中提取类型信息。Valibot 作为一个类型安全的验证库，提供了强大的类型推断能力。本文将介绍如何从 Valibot 的 Schema 中提取特定的元数据信息。

元数据提取需求

假设我们有一个用户 Schema，其中使用了 title 元数据来标识这个 Schema 的用途：

const UserSchema = v.pipe(
  v.object({
    email: v.pipe(v.string(), v.email()),
    password: v.pipe(v.string(), v.minLength(8)),
  }),
  v.title('user')
);

我们希望能够提取出这个 title 的值作为类型，即 'user'。

解决方案

Valibot 的 Schema 类型包含了完整的类型信息，我们可以通过类型操作来提取特定的元数据。以下是提取 title 元数据的类型工具：

type ExtractTitle<T extends v.BaseSchema> = Extract<
  T['pipe'][number],
  { type: 'title' }
>['title'];

这个类型工具的工作原理：

1. 访问 Schema 的 pipe 属性，它是一个包含所有验证管道的数组
2. 使用 Extract 条件类型筛选出类型为 'title' 的管道项
3. 从匹配的项中提取 title 属性

使用示例

我们可以这样使用上述类型工具：

type UserTitle = ExtractTitle<typeof UserSchema>;
// 类型推断为 'user'

扩展应用

这个模式可以推广到提取其他类型的元数据。例如，如果我们想提取 description 元数据：

type ExtractDescription<T extends v.BaseSchema> = Extract<
  T['pipe'][number],
  { type: 'description' }
>['description'];

类型安全的优势

这种类型提取方式完全类型安全，具有以下优点：

1. 编译时就能确保类型正确性
2. 编辑器可以提供完善的代码补全和类型提示
3. 当 Schema 变更时，类型会自动更新，减少运行时错误

总结

Valibot 提供了丰富的类型信息，通过 TypeScript 的类型操作，我们可以灵活地提取 Schema 中的各种元数据。这种技术可以用于构建更类型安全的应用程序，特别是在需要根据 Schema 元数据进行逻辑分支或类型映射的场景中非常有用。