Marc Mintel
5397309103
Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
34 lines
1.3 KiB
Plaintext
34 lines
1.3 KiB
Plaintext
// @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);
|
|
});
|