Class ZodDefault<T>

Type Parameters

T extends Zod.z.ZodTypeAny

Hierarchy (View Summary)

Zod.z.ZodType<
    noUndefined<T["_output"]>,
    Zod.z.ZodDefaultDef<T>,
    T["_input"] | undefined,
>
- ZodDefault

Index

Constructors

constructor

new ZodDefault<T extends Zod.z.ZodTypeAny>(
def: Zod.z.ZodDefaultDef<T>,
): Zod.z.ZodDefault<T>
Type Parameters
- T extends Zod.z.ZodTypeAny
Parameters
- def: Zod.z.ZodDefaultDef<T>
Returns Zod.z.ZodDefault<T>
Inherited from ZodType.constructor
- Defined in node_modules/zod/lib/types.d.ts:73

Properties

`Readonly`_def

_def: Zod.z.ZodDefaultDef<T>

`Readonly`_input

_input: undefined | T["_input"]

`Readonly`_output

_output: noUndefined<T["_output"]>

`Readonly`_type

_type: noUndefined<T["_output"]>

spa

spa: (
    data: unknown,
    params?: Partial<Zod.z.ParseParams>,
) => Promise<
    Zod.z.SafeParseReturnType<
        undefined
        | T["_input"],
        noUndefined<T["_output"]>,
    >,
>

Alias of safeParseAsync

`Static`create

create: <T_1 extends Zod.z.ZodTypeAny>(
    type: T_1,
    params: {
        description?: string;
        errorMap?: Zod.z.ZodErrorMap;
        invalid_type_error?: string;
        required_error?: string;
    } & { default: T_1["_input"]
    | () => noUndefined<T_1["_input"]> },
) => Zod.z.ZodDefault<T_1>

Accessors

description

get description(): undefined | string
Returns undefined | string
Inherited from ZodType.description
- Defined in node_modules/zod/lib/types.d.ts:49

Methods

_getOrReturnCtx

_getOrReturnCtx(
input: Zod.z.ParseInput,
ctx?: Zod.z.ParseContext,
): Zod.z.ParseContext
Parameters
- input: Zod.z.ParseInput
- Optionalctx: Zod.z.ParseContext
Returns Zod.z.ParseContext
Inherited from ZodType._getOrReturnCtx
- Defined in node_modules/zod/lib/types.d.ts:52

_getType

_getType(input: Zod.z.ParseInput): string
Parameters
- input: Zod.z.ParseInput
Returns string
Inherited from ZodType._getType
- Defined in node_modules/zod/lib/types.d.ts:51

_parse

_parse(
input: Zod.z.ParseInput,
): Zod.z.ParseReturnType<noUndefined<T["_output"]>>
Parameters
- input: Zod.z.ParseInput
Returns Zod.z.ParseReturnType<noUndefined<T["_output"]>>
Overrides ZodType._parse
- Defined in node_modules/zod/lib/types.d.ts:818

_parseAsync

_parseAsync(
input: Zod.z.ParseInput,
): Zod.z.AsyncParseReturnType<noUndefined<T["_output"]>>
Parameters
- input: Zod.z.ParseInput
Returns Zod.z.AsyncParseReturnType<noUndefined<T["_output"]>>
Inherited from ZodType._parseAsync
- Defined in node_modules/zod/lib/types.d.ts:58

_parseSync

_parseSync(
input: Zod.z.ParseInput,
): Zod.z.SyncParseReturnType<noUndefined<T["_output"]>>
Parameters
- input: Zod.z.ParseInput
Returns Zod.z.SyncParseReturnType<noUndefined<T["_output"]>>
Inherited from ZodType._parseSync
- Defined in node_modules/zod/lib/types.d.ts:57

_processInputParams

_processInputParams(
input: Zod.z.ParseInput,
): { ctx: Zod.z.ParseContext; status: Zod.z.ParseStatus }
Parameters
- input: Zod.z.ParseInput
Returns { ctx: Zod.z.ParseContext; status: Zod.z.ParseStatus }
Inherited from ZodType._processInputParams
- Defined in node_modules/zod/lib/types.d.ts:53

_refinement

_refinement(
    refinement: (
        arg: noUndefined<T["_output"]>,
        ctx: Zod.z.RefinementCtx,
    ) => any,
): Zod.z.ZodEffects<
    Zod.z.ZodDefault<T>,
    noUndefined<T["_output"]>,
    undefined | T["_input"],
>
Parameters
- refinement: (arg: noUndefined<T["_output"]>, ctx: Zod.z.RefinementCtx) => any
Returns Zod.z.ZodEffects<
    Zod.z.ZodDefault<T>,
    noUndefined<T["_output"]>,
    undefined | T["_input"],
>
Inherited from ZodType._refinement
- Defined in node_modules/zod/lib/types.d.ts:69

and

and<T extends Zod.z.ZodTypeAny>(
incoming: T,
): Zod.z.ZodIntersection<Zod.z.ZodDefault<T>, T>
Type Parameters
- T extends Zod.z.ZodTypeAny
Parameters
- incoming: T
Returns Zod.z.ZodIntersection<Zod.z.ZodDefault<T>, T>
Inherited from ZodType.and
- Defined in node_modules/zod/lib/types.d.ts:80

array

array(): Zod.z.ZodArray<Zod.z.ZodDefault<T>, "many">
Returns Zod.z.ZodArray<Zod.z.ZodDefault<T>, "many">
Inherited from ZodType.array
- Defined in node_modules/zod/lib/types.d.ts:77

brand

brand<B extends string | number | symbol>(
brand?: B,
): Zod.z.ZodBranded<Zod.z.ZodDefault<T>, B>
Type Parameters
- B extends string | number | symbol
Parameters
- Optionalbrand: B
Returns Zod.z.ZodBranded<Zod.z.ZodDefault<T>, B>
Inherited from ZodType.brand
- Defined in node_modules/zod/lib/types.d.ts:84

catch

catch(def: noUndefined<T["_output"]>): Zod.z.ZodCatch<Zod.z.ZodDefault<T>>
Parameters
- def: noUndefined<T["_output"]>
Returns Zod.z.ZodCatch<Zod.z.ZodDefault<T>>
Inherited from ZodType.catch
- Defined in node_modules/zod/lib/types.d.ts:85
catch(
    def: (
        ctx: { error: Zod.z.ZodError<any>; input: undefined | T["_input"] },
    ) => noUndefined<T["_output"]>,
): Zod.z.ZodCatch<Zod.z.ZodDefault<T>>
Parameters
- def: (
  ctx: { error: Zod.z.ZodError<any>; input: undefined | T["_input"] },
  ) => noUndefined<T["_output"]>
Returns Zod.z.ZodCatch<Zod.z.ZodDefault<T>>
Inherited from ZodType.catch
- Defined in node_modules/zod/lib/types.d.ts:86

default

default(def: noUndefined<T["_input"]>): Zod.z.ZodDefault<Zod.z.ZodDefault<T>>
Parameters
- def: noUndefined<T["_input"]>
Returns Zod.z.ZodDefault<Zod.z.ZodDefault<T>>
Inherited from ZodType.default
- Defined in node_modules/zod/lib/types.d.ts:82
default(
def: () => noUndefined<T["_input"]>,
): Zod.z.ZodDefault<Zod.z.ZodDefault<T>>
Parameters
- def: () => noUndefined<T["_input"]>
Returns Zod.z.ZodDefault<Zod.z.ZodDefault<T>>
Inherited from ZodType.default
- Defined in node_modules/zod/lib/types.d.ts:83

describe

describe(description: string): this
Parameters
- description: string
Returns this
Inherited from ZodType.describe
- Defined in node_modules/zod/lib/types.d.ts:90

isNullable

isNullable(): boolean
Returns boolean
Inherited from ZodType.isNullable
- Defined in node_modules/zod/lib/types.d.ts:94

isOptional

isOptional(): boolean
Returns boolean
Inherited from ZodType.isOptional
- Defined in node_modules/zod/lib/types.d.ts:93

nullable

nullable(): Zod.z.ZodNullable<Zod.z.ZodDefault<T>>
Returns Zod.z.ZodNullable<Zod.z.ZodDefault<T>>
Inherited from ZodType.nullable
- Defined in node_modules/zod/lib/types.d.ts:75

nullish

nullish(): Zod.z.ZodOptional<Zod.z.ZodNullable<Zod.z.ZodDefault<T>>>
Returns Zod.z.ZodOptional<Zod.z.ZodNullable<Zod.z.ZodDefault<T>>>
Inherited from ZodType.nullish
- Defined in node_modules/zod/lib/types.d.ts:76

optional

optional(): Zod.z.ZodOptional<Zod.z.ZodDefault<T>>
Returns Zod.z.ZodOptional<Zod.z.ZodDefault<T>>
Inherited from ZodType.optional
- Defined in node_modules/zod/lib/types.d.ts:74

or

or<T extends Zod.z.ZodTypeAny>(
option: T,
): Zod.z.ZodUnion<[Zod.z.ZodDefault<T>, T]>
Type Parameters
- T extends Zod.z.ZodTypeAny
Parameters
- option: T
Returns Zod.z.ZodUnion<[Zod.z.ZodDefault<T>, T]>
Inherited from ZodType.or
- Defined in node_modules/zod/lib/types.d.ts:79

parse

parse(
data: unknown,
params?: Partial<Zod.z.ParseParams>,
): noUndefined<T["_output"]>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.z.ParseParams>
Returns noUndefined<T["_output"]>
Inherited from ZodType.parse
- Defined in node_modules/zod/lib/types.d.ts:59

parseAsync

parseAsync(
data: unknown,
params?: Partial<Zod.z.ParseParams>,
): Promise<noUndefined<T["_output"]>>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.z.ParseParams>
Returns Promise<noUndefined<T["_output"]>>
Inherited from ZodType.parseAsync
- Defined in node_modules/zod/lib/types.d.ts:61

pipe

pipe<T extends Zod.z.ZodTypeAny>(
target: T,
): Zod.z.ZodPipeline<Zod.z.ZodDefault<T>, T>
Type Parameters
- T extends Zod.z.ZodTypeAny
Parameters
- target: T
Returns Zod.z.ZodPipeline<Zod.z.ZodDefault<T>, T>
Inherited from ZodType.pipe
- Defined in node_modules/zod/lib/types.d.ts:91

promise

promise(): Zod.z.ZodPromise<Zod.z.ZodDefault<T>>
Returns Zod.z.ZodPromise<Zod.z.ZodDefault<T>>
Inherited from ZodType.promise
- Defined in node_modules/zod/lib/types.d.ts:78

readonly

readonly(): Zod.z.ZodReadonly<Zod.z.ZodDefault<T>>
Returns Zod.z.ZodReadonly<Zod.z.ZodDefault<T>>
Inherited from ZodType.readonly
- Defined in node_modules/zod/lib/types.d.ts:92

refine

refine<RefinedOutput extends any>(
    check: (arg: noUndefined<T["_output"]>) => arg is RefinedOutput,
    message?:
        | string
        | Partial<Omit<Zod.z.ZodCustomIssue, "code">>
        | (
            arg: noUndefined<T["_output"]>,
        ) => Partial<Omit<Zod.z.ZodCustomIssue, "code">>,
): Zod.z.ZodEffects<
    Zod.z.ZodDefault<T>,
    RefinedOutput,
    undefined | T["_input"],
>
Type Parameters
- RefinedOutput extends any
Parameters
- check: (arg: noUndefined<T["_output"]>) => arg is RefinedOutput
- Optionalmessage:
      | string
      | Partial<Omit<Zod.z.ZodCustomIssue, "code">>
      | (
          arg: noUndefined<T["_output"]>,
      ) => Partial<Omit<Zod.z.ZodCustomIssue, "code">>
Returns Zod.z.ZodEffects<Zod.z.ZodDefault<T>, RefinedOutput, undefined | T["_input"]>
Inherited from ZodType.refine
- Defined in node_modules/zod/lib/types.d.ts:65
refine(
    check: (arg: noUndefined<T["_output"]>) => unknown,
    message?:
        | string
        | Partial<Omit<Zod.z.ZodCustomIssue, "code">>
        | (
            arg: noUndefined<T["_output"]>,
        ) => Partial<Omit<Zod.z.ZodCustomIssue, "code">>,
): Zod.z.ZodEffects<
    Zod.z.ZodDefault<T>,
    noUndefined<T["_output"]>,
    undefined | T["_input"],
>
Parameters
- check: (arg: noUndefined<T["_output"]>) => unknown
- Optionalmessage:
      | string
      | Partial<Omit<Zod.z.ZodCustomIssue, "code">>
      | (
          arg: noUndefined<T["_output"]>,
      ) => Partial<Omit<Zod.z.ZodCustomIssue, "code">>
Returns Zod.z.ZodEffects<
    Zod.z.ZodDefault<T>,
    noUndefined<T["_output"]>,
    undefined | T["_input"],
>
Inherited from ZodType.refine
- Defined in node_modules/zod/lib/types.d.ts:66

refinement

refinement<RefinedOutput extends any>(
    check: (arg: noUndefined<T["_output"]>) => arg is RefinedOutput,
    refinementData:
        | Zod.z.IssueData
        | (
            arg: noUndefined<T["_output"]>,
            ctx: Zod.z.RefinementCtx,
        ) => Zod.z.IssueData,
): Zod.z.ZodEffects<
    Zod.z.ZodDefault<T>,
    RefinedOutput,
    undefined | T["_input"],
>
Type Parameters
- RefinedOutput extends any
Parameters
- check: (arg: noUndefined<T["_output"]>) => arg is RefinedOutput
- refinementData:
      | Zod.z.IssueData
      | (
          arg: noUndefined<T["_output"]>,
          ctx: Zod.z.RefinementCtx,
      ) => Zod.z.IssueData
Returns Zod.z.ZodEffects<Zod.z.ZodDefault<T>, RefinedOutput, undefined | T["_input"]>
Inherited from ZodType.refinement
- Defined in node_modules/zod/lib/types.d.ts:67
refinement(
    check: (arg: noUndefined<T["_output"]>) => boolean,
    refinementData:
        | Zod.z.IssueData
        | (
            arg: noUndefined<T["_output"]>,
            ctx: Zod.z.RefinementCtx,
        ) => Zod.z.IssueData,
): Zod.z.ZodEffects<
    Zod.z.ZodDefault<T>,
    noUndefined<T["_output"]>,
    undefined | T["_input"],
>
Parameters
- check: (arg: noUndefined<T["_output"]>) => boolean
- refinementData:
      | Zod.z.IssueData
      | (
          arg: noUndefined<T["_output"]>,
          ctx: Zod.z.RefinementCtx,
      ) => Zod.z.IssueData
Returns Zod.z.ZodEffects<
    Zod.z.ZodDefault<T>,
    noUndefined<T["_output"]>,
    undefined | T["_input"],
>
Inherited from ZodType.refinement
- Defined in node_modules/zod/lib/types.d.ts:68

removeDefault

removeDefault(): T
Returns T
- Defined in node_modules/zod/lib/types.d.ts:819

safeParse

safeParse(
    data: unknown,
    params?: Partial<Zod.z.ParseParams>,
): Zod.z.SafeParseReturnType<
    undefined
    | T["_input"],
    noUndefined<T["_output"]>,
>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.z.ParseParams>
Returns Zod.z.SafeParseReturnType<undefined | T["_input"], noUndefined<T["_output"]>>
Inherited from ZodType.safeParse
- Defined in node_modules/zod/lib/types.d.ts:60

safeParseAsync

safeParseAsync(
    data: unknown,
    params?: Partial<Zod.z.ParseParams>,
): Promise<
    Zod.z.SafeParseReturnType<
        undefined
        | T["_input"],
        noUndefined<T["_output"]>,
    >,
>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.z.ParseParams>
Returns Promise<
    Zod.z.SafeParseReturnType<
        undefined
        | T["_input"],
        noUndefined<T["_output"]>,
    >,
>
Inherited from ZodType.safeParseAsync
- Defined in node_modules/zod/lib/types.d.ts:62

superRefine

superRefine<RefinedOutput extends any>(
    refinement: (
        arg: noUndefined<T["_output"]>,
        ctx: Zod.z.RefinementCtx,
    ) => arg is RefinedOutput,
): Zod.z.ZodEffects<
    Zod.z.ZodDefault<T>,
    RefinedOutput,
    undefined | T["_input"],
>
Type Parameters
- RefinedOutput extends any
Parameters
- refinement: (
  arg: noUndefined<T["_output"]>,
  ctx: Zod.z.RefinementCtx,
  ) => arg is RefinedOutput
Returns Zod.z.ZodEffects<Zod.z.ZodDefault<T>, RefinedOutput, undefined | T["_input"]>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/lib/types.d.ts:70
superRefine(
    refinement: (
        arg: noUndefined<T["_output"]>,
        ctx: Zod.z.RefinementCtx,
    ) => void,
): Zod.z.ZodEffects<
    Zod.z.ZodDefault<T>,
    noUndefined<T["_output"]>,
    undefined | T["_input"],
>
Parameters
- refinement: (arg: noUndefined<T["_output"]>, ctx: Zod.z.RefinementCtx) => void
Returns Zod.z.ZodEffects<
    Zod.z.ZodDefault<T>,
    noUndefined<T["_output"]>,
    undefined | T["_input"],
>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/lib/types.d.ts:71
superRefine(
    refinement: (
        arg: noUndefined<T["_output"]>,
        ctx: Zod.z.RefinementCtx,
    ) => Promise<void>,
): Zod.z.ZodEffects<
    Zod.z.ZodDefault<T>,
    noUndefined<T["_output"]>,
    undefined | T["_input"],
>
Parameters
- refinement: (arg: noUndefined<T["_output"]>, ctx: Zod.z.RefinementCtx) => Promise<void>
Returns Zod.z.ZodEffects<
    Zod.z.ZodDefault<T>,
    noUndefined<T["_output"]>,
    undefined | T["_input"],
>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/lib/types.d.ts:72

transform

transform<NewOut>(
    transform: (
        arg: noUndefined<T["_output"]>,
        ctx: Zod.z.RefinementCtx,
    ) => NewOut | Promise<NewOut>,
): Zod.z.ZodEffects<Zod.z.ZodDefault<T>, NewOut, undefined | T["_input"]>
Type Parameters
- NewOut
Parameters
- transform: (
  arg: noUndefined<T["_output"]>,
  ctx: Zod.z.RefinementCtx,
  ) => NewOut | Promise<NewOut>
Returns Zod.z.ZodEffects<Zod.z.ZodDefault<T>, NewOut, undefined | T["_input"]>
Inherited from ZodType.transform
- Defined in node_modules/zod/lib/types.d.ts:81

Class ZodDefault<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Zod.z.ZodDefault<T>

Properties

Readonly_def

Readonly_input

Readonly_output

Readonly_type

spa

Staticcreate

Accessors

description

Returns undefined | string

Methods

_getOrReturnCtx

Parameters

Returns Zod.z.ParseContext

_getType

Parameters

Returns string

_parse

Parameters

Returns Zod.z.ParseReturnType<noUndefined<T["_output"]>>

_parseAsync

Parameters

Returns Zod.z.AsyncParseReturnType<noUndefined<T["_output"]>>

_parseSync

Parameters

Returns Zod.z.SyncParseReturnType<noUndefined<T["_output"]>>

_processInputParams

Parameters

Returns { ctx: Zod.z.ParseContext; status: Zod.z.ParseStatus }

_refinement

Parameters

Returns Zod.z.ZodEffects< Zod.z.ZodDefault<T>, noUndefined<T["_output"]>, undefined | T["_input"],>

and

Type Parameters

Parameters

Returns Zod.z.ZodIntersection<Zod.z.ZodDefault<T>, T>

array

Returns Zod.z.ZodArray<Zod.z.ZodDefault<T>, "many">

brand

Type Parameters

Parameters

Returns Zod.z.ZodBranded<Zod.z.ZodDefault<T>, B>

catch

Parameters

Returns Zod.z.ZodCatch<Zod.z.ZodDefault<T>>

Parameters

Returns Zod.z.ZodCatch<Zod.z.ZodDefault<T>>

default

Parameters

Returns Zod.z.ZodDefault<Zod.z.ZodDefault<T>>

Parameters

Returns Zod.z.ZodDefault<Zod.z.ZodDefault<T>>

describe

Parameters

Returns this

isNullable

Returns boolean

isOptional

Returns boolean

nullable

Returns Zod.z.ZodNullable<Zod.z.ZodDefault<T>>

nullish

Returns Zod.z.ZodOptional<Zod.z.ZodNullable<Zod.z.ZodDefault<T>>>

optional

Returns Zod.z.ZodOptional<Zod.z.ZodDefault<T>>

or

Type Parameters

`Readonly`_def

`Readonly`_input

`Readonly`_output

`Readonly`_type

`Static`create

Returns Zod.z.ZodEffects<
Zod.z.ZodDefault<T>,
noUndefined<T["_output"]>,
undefined | T["_input"],
>

Returns Zod.z.ZodEffects<
Zod.z.ZodDefault<T>,
noUndefined<T["_output"]>,
undefined | T["_input"],
>

Returns Zod.z.ZodEffects<
Zod.z.ZodDefault<T>,
noUndefined<T["_output"]>,
undefined | T["_input"],
>

Returns Promise<
Zod.z.SafeParseReturnType<
undefined
| T["_input"],
noUndefined<T["_output"]>,
>,
>

Returns Zod.z.ZodEffects<
Zod.z.ZodDefault<T>,
noUndefined<T["_output"]>,
undefined | T["_input"],
>

Returns Zod.z.ZodEffects<
Zod.z.ZodDefault<T>,
noUndefined<T["_output"]>,
undefined | T["_input"],
>