HEX
Server: Apache/2.4.41 (Ubuntu)
System: Linux ip-172-31-42-149 5.15.0-1084-aws #91~20.04.1-Ubuntu SMP Fri May 2 07:00:04 UTC 2025 aarch64
User: ubuntu (1000)
PHP: 7.4.33
Disabled: pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare,
Upload Files
File: /var/www/vhost/disk-apps/alq-cali.bikenow.co/node_modules/zod/src/v3/tests/description.test.ts
// @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);
});