如何使用 zod 验证字符串文字类型

Question

我有这种类型

export type PaymentType = 'CHECK' | 'DIRECT DEPOSIT' | 'MONEY ORDER';

我想在 zod 中验证这个文字字符串类型。 目前，我有 is 作为一个字符串，但错误的是不是一个字符串。 我不知道该放什么。

const schema = z.object({
    paymentType: z.string() // I want to validate this field
});

到目前为止，我已经尝试过枚举、字符串和对象。 我找不到正确的答案。

Answer 1

我评论说这可能是重复的，因为问题的核心可以用z.literal解决，但有点不同。 只是为了说明你可以做什么：

import { z } from 'zod';
const PaymentTypeSchema = z.union([
  z.literal('CHECK'),
  z.literal('DIRECT DEPOSIT'),
  z.literal('MONEY ORDER'),
]);
type PaymentType = z.infer<typeof PaymentTypeSchema>;

const schema = z.object({
  paymentType: PaymentTypeSchema,
});

比这更简单的方法是使用z.enum帮助程序，它删除了一些样板文件：

const PaymentTypeSchema = z.enum(["CHECK", "DIRECT DEPOSIT", "MONEY ORDER"]);
const schema = z.object({
  paymentType: PaymentTypeSchema,
});

或者，您可以将PaymentType变成枚举并使用z.nativeEnum来解析值，例如：

enum PaymentType {
  Check = 'CHECK',
  DirectDeposit = 'DIRECT DEPOSIT',
  MoneyOrder = 'MONEY ORDER'
}

const PaymentTypeSchema = z.nativeEnum(PaymentType);
const schema = z.object({
  paymentType: PaymentTypeSchema,
});