import * as vi from "vitest"
import { z } from "zod"
import { zx } from "@traversable/zod"
// Using `zx.deepNonStrict.writeable` here to make it easier to visualize `zx.deepNonStrict`'s behavior:
vi.expect.soft(zx.deepNonStrict.writeable(
z.strictObject({
a: z.number(),
b: z.nullable(z.string()),
c: z.strictObject({
d: z.array(
z.strictObject({
e: z.number().max(1),
f: z.boolean()
})
).length(10)
})
})
)).toMatchInlineSnapshot
(`
"z.object({
a: z.number(),
b: z.string().nullable(),
c: z.object({
d: z.array(
z.object({
e: z.number().max(1),
f: z.boolean()
})
).length(10)
})
})"
`)
zx.deepNonStrict.writeableConvenience function that composes zx.deepNonStrict
and zx.toString.
This option is useful when you have particularly large schemas, and are
starting to feel the TS compiler drag. With
zx.deepNonStrict.writeable, you
can pay that price one by writing the new schema to disc.
Keep in mind that the most expensive part of the transformation is at the type-level; writing to disc solves that problem, but introduces a syncing problem, so if you don't "own" the schema, make sure you've at least thought about what you'll do when the schema inevitably changes.
deepNonStrictConverts an arbitrary zod schema into its "deeply-non-strict" form.
That just means that the schema will be traversed, and all z.strictObject
z.strictObjectschemas will be rewritten as z.objectz.objectschemas.