Interface $ZodCatchCtx

Type declaration

• {
      path?: PropertyKey[];
      message?: string;
      code: "invalid_type";
      expected:
          | "string"
          | "number"
          | "bigint"
          | "boolean"
          | "symbol"
          | "undefined"
          | "object"
          | "function"
          | "lazy"
          | "int"
          | "null"
          | "void"
          | "never"
          | "any"
          | "unknown"
          | "date"
          | "record"
          | "file"
          | "array"
          | "tuple"
          | "union"
          | "intersection"
          | "map"
          | "set"
          | "enum"
          | "literal"
          | "nullable"
          | "optional"
          | "nonoptional"
          | "success"
          | "transform"
          | "default"
          | "prefault"
          | "catch"
          | "nan"
          | "pipe"
          | "readonly"
          | "template_literal"
          | "promise"
          | "custom";
      input: unknown;
      inst?: | $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
      | $ZodCheck<never>;
      continue?: boolean;
      [key: string]: unknown;
  }

  • [key: string]: unknown

  • Optional Readonlypath?: PropertyKey[]

  • Optional Readonlymessage?: string

  • Readonlycode: "invalid_type"

  • Readonlyexpected:
        | "string"
        | "number"
        | "bigint"
        | "boolean"
        | "symbol"
        | "undefined"
        | "object"
        | "function"
        | "lazy"
        | "int"
        | "null"
        | "void"
        | "never"
        | "any"
        | "unknown"
        | "date"
        | "record"
        | "file"
        | "array"
        | "tuple"
        | "union"
        | "intersection"
        | "map"
        | "set"
        | "enum"
        | "literal"
        | "nullable"
        | "optional"
        | "nonoptional"
        | "success"
        | "transform"
        | "default"
        | "prefault"
        | "catch"
        | "nan"
        | "pipe"
        | "readonly"
        | "template_literal"
        | "promise"
        | "custom"

  • Readonlyinput: unknown

    The input data

  • Optional Readonlyinst?:
        | $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
        | $ZodCheck<never>

    The schema or check that originated this issue.

  • Optional Readonlycontinue?: boolean

    If true, Zod will continue executing checks/refinements after this issue.
• {
      path?: PropertyKey[];
      message?: string;
      code: "too_big";
      origin:
          | "string"
          | "number"
          | "bigint"
          | "int"
          | "date"
          | "file"
          | "array"
          | "set"
          | string & {};
      maximum: number
      | bigint;
      inclusive?: boolean;
      exact?: boolean;
      input: unknown;
      inst?:
          | $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
          | $ZodCheck<never>;
      continue?: boolean;
      [key: string]: unknown;
  }

  • [key: string]: unknown

  • Optional Readonlypath?: PropertyKey[]

  • Optional Readonlymessage?: string

  • Readonlycode: "too_big"

  • Readonlyorigin:
        | "string"
        | "number"
        | "bigint"
        | "int"
        | "date"
        | "file"
        | "array"
        | "set"
        | string & {}

  • Readonlymaximum: number | bigint

  • Optional Readonlyinclusive?: boolean

  • Optional Readonlyexact?: boolean

  • Readonlyinput: unknown

    The input data

  • Optional Readonlyinst?:
        | $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
        | $ZodCheck<never>

    The schema or check that originated this issue.

  • Optional Readonlycontinue?: boolean

    If true, Zod will continue executing checks/refinements after this issue.
• {
      path?: PropertyKey[];
      message?: string;
      code: "too_small";
      origin:
          | "string"
          | "number"
          | "bigint"
          | "int"
          | "date"
          | "file"
          | "array"
          | "set"
          | string & {};
      minimum: number
      | bigint;
      inclusive?: boolean;
      exact?: boolean;
      input: unknown;
      inst?:
          | $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
          | $ZodCheck<never>;
      continue?: boolean;
      [key: string]: unknown;
  }

  • [key: string]: unknown

  • Optional Readonlypath?: PropertyKey[]

  • Optional Readonlymessage?: string

  • Readonlycode: "too_small"

  • Readonlyorigin:
        | "string"
        | "number"
        | "bigint"
        | "int"
        | "date"
        | "file"
        | "array"
        | "set"
        | string & {}

  • Readonlyminimum: number | bigint

  • Optional Readonlyinclusive?: boolean

    True if the allowable range includes the minimum

  • Optional Readonlyexact?: boolean

    True if the allowed value is fixed (e.g. z.length(5)), not a range (z.minLength(5))

  • Readonlyinput: unknown

    The input data

  • Optional Readonlyinst?:
        | $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
        | $ZodCheck<never>

    The schema or check that originated this issue.

  • Optional Readonlycontinue?: boolean

    If true, Zod will continue executing checks/refinements after this issue.
• {
      path?: PropertyKey[];
      message?: string;
      code: "invalid_format";
      format: string & {} | $ZodStringFormats;
      pattern?: string;
      input: undefined | string;
      inst?:
          | $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
          | $ZodCheck<never>;
      continue?: boolean;
      [key: string]: unknown;
  }

  • [key: string]: unknown

  • Optional Readonlypath?: PropertyKey[]

  • Optional Readonlymessage?: string

  • Readonlycode: "invalid_format"

  • Readonlyformat: string & {} | $ZodStringFormats

  • Optional Readonlypattern?: string

  • Readonlyinput: undefined | string

    The input data

  • Optional Readonlyinst?:
        | $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
        | $ZodCheck<never>

    The schema or check that originated this issue.

  • Optional Readonlycontinue?: boolean

    If true, Zod will continue executing checks/refinements after this issue.
• {
      path?: PropertyKey[];
      message?: string;
      code: "not_multiple_of";
      divisor: number;
      input: undefined | number | bigint;
      inst?:
          | $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
          | $ZodCheck<never>;
      continue?: boolean;
      [key: string]: unknown;
  }

  • [key: string]: unknown

  • Optional Readonlypath?: PropertyKey[]

  • Optional Readonlymessage?: string

  • Readonlycode: "not_multiple_of"

  • Readonlydivisor: number

  • Readonlyinput: undefined | number | bigint

    The input data

  • Optional Readonlyinst?:
        | $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
        | $ZodCheck<never>

    The schema or check that originated this issue.

  • Optional Readonlycontinue?: boolean

    If true, Zod will continue executing checks/refinements after this issue.
• {
      path?: PropertyKey[];
      message?: string;
      code: "unrecognized_keys";
      keys: string[];
      input: undefined | Record<string, unknown>;
      inst?:
          | $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
          | $ZodCheck<never>;
      continue?: boolean;
      [key: string]: unknown;
  }

  • [key: string]: unknown

  • Optional Readonlypath?: PropertyKey[]

  • Optional Readonlymessage?: string

  • Readonlycode: "unrecognized_keys"

  • Readonlykeys: string[]

  • Readonlyinput: undefined | Record<string, unknown>

    The input data

  • Optional Readonlyinst?:
        | $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
        | $ZodCheck<never>

    The schema or check that originated this issue.

  • Optional Readonlycontinue?: boolean

    If true, Zod will continue executing checks/refinements after this issue.
• {
      path?: PropertyKey[];
      message?: string;
      code: "invalid_union";
      errors: $ZodIssue[][];
      input: unknown;
      discriminator?: string;
      inst?:
          | $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
          | $ZodCheck<never>;
      continue?: boolean;
      [key: string]: unknown;
  }

  • [key: string]: unknown

  • Optional Readonlypath?: PropertyKey[]

  • Optional Readonlymessage?: string

  • Readonlycode: "invalid_union"

  • Readonlyerrors: $ZodIssue[][]

  • Readonlyinput: unknown

    The input data

  • Optional Readonlydiscriminator?: string

  • Optional Readonlyinst?:
        | $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
        | $ZodCheck<never>

    The schema or check that originated this issue.

  • Optional Readonlycontinue?: boolean

    If true, Zod will continue executing checks/refinements after this issue.
• {
      path?: PropertyKey[];
      message?: string;
      code: "invalid_key";
      origin: "record" | "map";
      issues: $ZodIssue[];
      input: unknown;
      inst?:
          | $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
          | $ZodCheck<never>;
      continue?: boolean;
      [key: string]: unknown;
  }

  • [key: string]: unknown

  • Optional Readonlypath?: PropertyKey[]

  • Optional Readonlymessage?: string

  • Readonlycode: "invalid_key"

  • Readonlyorigin: "record" | "map"

  • Readonlyissues: $ZodIssue[]

  • Readonlyinput: unknown

    The input data

  • Optional Readonlyinst?:
        | $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
        | $ZodCheck<never>

    The schema or check that originated this issue.

  • Optional Readonlycontinue?: boolean

    If true, Zod will continue executing checks/refinements after this issue.
• {
      path?: PropertyKey[];
      message?: string;
      code: "invalid_element";
      origin: "map" | "set";
      key: unknown;
      issues: $ZodIssue[];
      input: unknown;
      inst?:
          | $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
          | $ZodCheck<never>;
      continue?: boolean;
      [key: string]: unknown;
  }

  • [key: string]: unknown

  • Optional Readonlypath?: PropertyKey[]

  • Optional Readonlymessage?: string

  • Readonlycode: "invalid_element"

  • Readonlyorigin: "map" | "set"

  • Readonlykey: unknown

  • Readonlyissues: $ZodIssue[]

  • Readonlyinput: unknown

    The input data

  • Optional Readonlyinst?:
        | $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
        | $ZodCheck<never>

    The schema or check that originated this issue.

  • Optional Readonlycontinue?: boolean

    If true, Zod will continue executing checks/refinements after this issue.
• {
      path?: PropertyKey[];
      message?: string;
      code: "invalid_value";
      values: Primitive[];
      input: unknown;
      inst?:
          | $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
          | $ZodCheck<never>;
      continue?: boolean;
      [key: string]: unknown;
  }

  • [key: string]: unknown

  • Optional Readonlypath?: PropertyKey[]

  • Optional Readonlymessage?: string

  • Readonlycode: "invalid_value"

  • Readonlyvalues: Primitive[]

  • Readonlyinput: unknown

    The input data

  • Optional Readonlyinst?:
        | $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
        | $ZodCheck<never>

    The schema or check that originated this issue.

  • Optional Readonlycontinue?: boolean

    If true, Zod will continue executing checks/refinements after this issue.
• {
      path?: PropertyKey[];
      message?: string;
      code: "custom";
      params?: Record<string, any>;
      input: unknown;
      inst?:
          | $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
          | $ZodCheck<never>;
      continue?: boolean;
      [key: string]: unknown;
  }

  • [key: string]: unknown

  • Optional Readonlypath?: PropertyKey[]

  • Optional Readonlymessage?: string

  • Readonlycode: "custom"

  • Optional Readonlyparams?: Record<string, any>

  • Readonlyinput: unknown

    The input data

  • Optional Readonlyinst?:
        | $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
        | $ZodCheck<never>

    The schema or check that originated this issue.

  • Optional Readonlycontinue?: boolean

    If true, Zod will continue executing checks/refinements after this issue.