Valibot 枚举类型验证的最佳实践

Valibot 是一个强大的 TypeScript 数据验证库，在处理枚举类型验证时，开发者可能会遇到一些类型安全的问题。本文将深入探讨 Valibot 中处理枚举验证的最佳实践。

枚举验证的常见问题

在 Valibot 中使用枚举验证时，开发者通常会遇到两种主要问题：

1. 类型不匹配：当尝试直接使用字符串字面量而不是枚举成员时，TypeScript 会报类型错误
2. 自动补全缺失：在某些情况下，IDE 无法提供枚举成员的自动补全功能

解决方案一：使用 enum_ 验证器

Valibot 提供了 enum_ 验证器来专门处理 TypeScript 枚举：

enum EnumPriority {
  Low = 'Low',
  Medium = 'Medium',
  High = 'High',
  WithoutPriority = 'Without priority'
}

const CardSchema = v.object({
  priority: v.enum_(EnumPriority)
});

使用这种方式时，必须通过枚举成员来赋值：

const data = {
  priority: EnumPriority.WithoutPriority // 正确
  // priority: 'Without priority' // 错误
};

解决方案二：使用 picklist 验证器

对于不想依赖枚举的场景，可以使用 picklist 验证器：

const priority = ['Low', 'Medium', 'High', 'Without priority'] as const;

const CardSchema = v.object({
  priority: v.picklist(priority)
});

这种方式允许直接使用字符串字面量：

const data = {
  priority: 'Without priority' // 正确
};

重要注意事项

1. 避免使用 Object.values(Enum)：这可能会导致包含枚举键的问题，Valibot 内部使用了更安全的实现方式：

const options = Object.entries(enum__)
    .filter(([key]) => isNaN(+key))
    .map(([, value]) => value) as (keyof TEnum)[];

2. 类型推断：使用 as const 断言可以确保 picklist 获得完整的类型安全

3. 共享常量：如果需要同时在验证和渲染中使用相同的选项列表，可以这样处理：

const priorityOptions = ['Low', 'Medium', 'High', 'Without priority'] as const;

// 验证
const CardSchema = v.object({
  priority: v.picklist(priorityOptions)
});

// 渲染
priorityOptions.map(option => <option key={option}>{option}</option>);

结论

Valibot 提供了灵活的方式来处理枚举验证，开发者可以根据项目需求选择：

• 需要严格类型安全时，使用 enum_ 验证器配合 TypeScript 枚举
• 需要更灵活的字面量时，使用 picklist 验证器配合 as const 断言
• 避免直接使用 Object.values(Enum) 来获取枚举值

理解这些最佳实践将帮助开发者在 Valibot 中实现更健壮、类型安全的枚举验证。