zod/src/v3/tests/description.test.ts

TypeScript-first schema declaration and validation library with static type inference

// @ts-ignore TS6133
import { expect, test } from "vitest";

import * as z from "zod/v3";

const description = "a description";

test("passing `description` to schema should add a description", () => {
  expect(z.string({ description }).description).toEqual(description);
  expect(z.number({ description }).description).toEqual(description);
  expect(z.boolean({ description }).description).toEqual(description);
});

test("`.describe` should add a description", () => {
  expect(z.string().describe(description).description).toEqual(description);
  expect(z.number().describe(description).description).toEqual(description);
  expect(z.boolean().describe(description).description).toEqual(description);
});

test("description should carry over to chained schemas", () => {
  const schema = z.string({ description });
  expect(schema.description).toEqual(description);
  expect(schema.optional().description).toEqual(description);
  expect(schema.optional().nullable().default("default").description).toEqual(description);
});

test("description should not carry over to chained array schema", () => {
  const schema = z.string().describe(description);

  expect(schema.description).toEqual(description);
  expect(schema.array().description).toEqual(undefined);
  expect(z.array(schema).description).toEqual(undefined);
});