Skip to main content
Module

x/zod/__tests__/tuple.test.ts

TypeScript-first schema validation with static type inference
Extremely Popular
Go to Latest
File
// @ts-ignore TS6133import { expect } from "https://deno.land/x/expect@v0.2.6/mod.ts";const test = Deno.test;
import { util } from "../helpers/util.ts";import * as z from "../index.ts";import { ZodError } from "../ZodError.ts";
const testTuple = z.tuple([ z.string(), z.object({ name: z.literal("Rudy") }), z.array(z.literal("blue")),]);const testData = ["asdf", { name: "Rudy" }, ["blue"]];const badData = [123, { name: "Rudy2" }, ["blue", "red"]];
test("tuple inference", () => { const args1 = z.tuple([z.string()]); const returns1 = z.number(); const func1 = z.function(args1, returns1); type func1 = z.TypeOf<typeof func1>; util.assertEqual<func1, (k: string) => number>(true);});
test("successful validation", () => { const val = testTuple.parse(testData); expect(val).toEqual(["asdf", { name: "Rudy" }, ["blue"]]);});
test("successful async validation", async () => { const val = await testTuple.parseAsync(testData); return expect(val).toEqual(testData);});
test("failed validation", () => { const checker = () => { testTuple.parse([123, { name: "Rudy2" }, ["blue", "red"]] as any); }; try { checker(); } catch (err) { if (err instanceof ZodError) { expect(err.issues.length).toEqual(3); } }});
test("failed async validation", async () => { const res = await testTuple.safeParse(badData); expect(res.success).toEqual(false); if (!res.success) { expect(res.error.issues.length).toEqual(3); } // try { // checker(); // } catch (err) { // if (err instanceof ZodError) { // expect(err.issues.length).toEqual(3); // } // }});
test("tuple with transformers", () => { const stringToNumber = z.string().transform((val) => val.length); const val = z.tuple([stringToNumber]);
type t1 = z.input<typeof val>; util.assertEqual<t1, [string]>(true); type t2 = z.output<typeof val>; util.assertEqual<t2, [number]>(true); expect(val.parse(["1234"])).toEqual([4]);});
test("tuple with rest schema", () => { const myTuple = z.tuple([z.string(), z.number()]).rest(z.boolean()); expect(myTuple.parse(["asdf", 1234, true, false, true])).toEqual([ "asdf", 1234, true, false, true, ]);
expect(myTuple.parse(["asdf", 1234])).toEqual(["asdf", 1234]);
expect(() => myTuple.parse(["asdf", 1234, "asdf"])).toThrow(); type t1 = z.output<typeof myTuple>;
util.assertEqual<t1, [string, number, ...boolean[]]>(true);});
// test('tuple with optional elements', () => {// const result = z// .tuple([z.string(), z.number().optional()])// .safeParse(['asdf']);// expect(result).toEqual(['asdf']);// });