lspeasy / core/src / exampleFromZod
Function: exampleFromZod()
ts
function exampleFromZod(schema, depth?): unknown;Defined in: packages/core/src/example-from-zod.ts:16
Build an illustrative, required-only example value from a Zod schema. Strings → "example", numbers → 1, booleans → false, enum/literal → first value, objects → required props (optionals/nullables/defaults omitted), arrays → one sample element. Recursion is capped at MAX_DEPTH (returns null). The lsproxy CLI uses this to show example request/response payloads.
Parameters
| Parameter | Type | Default value |
|---|---|---|
schema | ZodType | undefined |
depth | number | 0 |
Returns
unknown
Remarks
Uses Zod 4 public instanceof checks and typed accessors — no internal _def reads.