x-to-zod / Options

Type Alias: Options

type Options = {
  depth?: number;
  disableRefs?: boolean;
  module?: "cjs" | "esm" | "none";
  name?: string;
  noImport?: boolean;
  postProcessors?: (
     | PostProcessor
    | PostProcessorConfig)[];
  preferUnions?: boolean;
  transformers?: SchemaTransformer[];
  type?: boolean | string;
  withJsdocs?: boolean;
  withoutDefaults?: boolean;
  withoutDescribes?: boolean;
  zodVersion?: "v3" | "v4";
};

Defined in: src/context.ts:11

Properties

depth?

optional depth?: number;

Defined in: src/context.ts:17

---

disableRefs?

optional disableRefs?: boolean;

Defined in: src/context.ts:21

---

module?

optional module?: "cjs" | "esm" | "none";

Defined in: src/context.ts:13

---

name?

optional name?: string;

Defined in: src/context.ts:12

---

noImport?

optional noImport?: boolean;

Defined in: src/context.ts:19

---

postProcessors?

optional postProcessors?: (
  | PostProcessor
  | PostProcessorConfig)[];

Defined in: src/context.ts:27

Post-processors to transform builders after parsing

---

preferUnions?

optional preferUnions?: boolean;

Defined in: src/context.ts:20

---

transformers?

optional transformers?: SchemaTransformer[];

Defined in: src/context.ts:25

Schema transformers applied before parsing

---

type?

optional type?: boolean | string;

Defined in: src/context.ts:18

---

withJsdocs?

optional withJsdocs?: boolean;

Defined in: src/context.ts:16

---

withoutDefaults?

optional withoutDefaults?: boolean;

Defined in: src/context.ts:14

---

withoutDescribes?

optional withoutDescribes?: boolean;

Defined in: src/context.ts:15

---

zodVersion?

optional zodVersion?: "v3" | "v4";

Defined in: src/context.ts:23

Zod version to target for generated code (default: 'v4')