Class ZodFunction<Args, Returns>

Type Parameters

Args extends ZodTuple<any, any>
Returns extends ZodTypeAny

Hierarchy (View Summary)

ZodType<
    OuterTypeOfFunction<Args, Returns>,
    ZodFunctionDef<Args, Returns>,
    InnerTypeOfFunction<Args, Returns>,
>
- ZodFunction

Index

Constructors

constructor

new ZodFunction<
    Args extends ZodTuple<any, any, Args>,
    Returns extends ZodType<any, any, any, Returns>,
>(
    def: ZodFunctionDef<Args, Returns>,
): ZodFunction<Args, Returns>
Type Parameters
- Args extends ZodTuple<any, any, Args>
- Returns extends ZodType<any, any, any, Returns>
Parameters
- def: ZodFunctionDef<Args, Returns>
Returns ZodFunction<Args, Returns>
Inherited from ZodType.constructor
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:76

Properties

spa

spa: (
    data: unknown,
    params?: Partial<ParseParams>,
) => Promise<
    SafeParseReturnType<
        InnerTypeOfFunction<Args, Returns>,
        OuterTypeOfFunction<Args, Returns>,
    >,
>

Alias of safeParseAsync

validate

validate: <F extends (...args: any[any]) => Returns["_input"]>(
    func: F,
) => ReturnType<F> extends Returns["_output"]
    ? (...args: Args["_input"]) => ReturnType<ReturnType<F>>
    : OuterTypeOfFunction<Args, Returns>

Accessors

description

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

Methods

_getOrReturnCtx

_getOrReturnCtx(input: ParseInput, ctx?: ParseContext): ParseContext
Parameters
- input: ParseInput
- Optionalctx: ParseContext
Returns ParseContext
Inherited from ZodType._getOrReturnCtx
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:55

_getType

_getType(input: ParseInput): string
Parameters
- input: ParseInput
Returns string
Inherited from ZodType._getType
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:54

_parse

_parse(input: ParseInput): ParseReturnType<any>
Parameters
- input: ParseInput
Returns ParseReturnType<any>
Overrides ZodType._parse
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:728

_parseAsync

_parseAsync(
input: ParseInput,
): AsyncParseReturnType<OuterTypeOfFunction<Args, Returns>>
Parameters
- input: ParseInput
Returns AsyncParseReturnType<OuterTypeOfFunction<Args, Returns>>
Inherited from ZodType._parseAsync
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:61

_parseSync

_parseSync(
input: ParseInput,
): SyncParseReturnType<OuterTypeOfFunction<Args, Returns>>
Parameters
- input: ParseInput
Returns SyncParseReturnType<OuterTypeOfFunction<Args, Returns>>
Inherited from ZodType._parseSync
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:60

_processInputParams

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

_refinement

_refinement(
    refinement: (
        arg: OuterTypeOfFunction<Args, Returns>,
        ctx: RefinementCtx,
    ) => any,
): ZodEffects<
    ZodFunction<Args, Returns>,
    OuterTypeOfFunction<Args, Returns>,
    InnerTypeOfFunction<Args, Returns>,
>
Parameters
- refinement: (arg: OuterTypeOfFunction<Args, Returns>, ctx: RefinementCtx) => any
Returns ZodEffects<
    ZodFunction<Args, Returns>,
    OuterTypeOfFunction<Args, Returns>,
    InnerTypeOfFunction<Args, Returns>,
>
Inherited from ZodType._refinement
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:72

and

and<T extends ZodType<any, any, any, T>>(
incoming: T,
): ZodIntersection<ZodFunction<Args, Returns>, T>
Type Parameters
- T extends ZodType<any, any, any, T>
Parameters
- incoming: T
Returns ZodIntersection<ZodFunction<Args, Returns>, T>
Inherited from ZodType.and
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:83

args

args<Items extends [] | [ZodTypeAny, ...ZodTypeAny[]]>(
...items: Items,
): ZodFunction<ZodTuple<Items, ZodUnknown>, Returns>
Type Parameters
- Items extends [] | [ZodTypeAny, ...ZodTypeAny[]]
Parameters
- ...items: Items
Returns ZodFunction<ZodTuple<Items, ZodUnknown>, Returns>
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:731

array

array(): ZodArray<ZodFunction<Args, Returns>, "many">
Returns ZodArray<ZodFunction<Args, Returns>, "many">
Inherited from ZodType.array
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:80

brand

brand<B extends string | number | symbol>(
brand?: B,
): ZodBranded<ZodFunction<Args, Returns>, B>
Type Parameters
- B extends string | number | symbol
Parameters
- Optionalbrand: B
Returns ZodBranded<ZodFunction<Args, Returns>, B>
Inherited from ZodType.brand
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:87

catch

catch(
def: OuterTypeOfFunction<Args, Returns>,
): ZodCatch<ZodFunction<Args, Returns>>
Parameters
- def: OuterTypeOfFunction<Args, Returns>
Returns ZodCatch<ZodFunction<Args, Returns>>
Inherited from ZodType.catch
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:88
catch(
    def: (
        ctx: {
            error: ZodError<any>;
            input: InnerTypeOfFunction<Args, Returns>;
        },
    ) => OuterTypeOfFunction<Args, Returns>,
): ZodCatch<ZodFunction<Args, Returns>>
Parameters
- def: (
  ctx: { error: ZodError<any>; input: InnerTypeOfFunction<Args, Returns> },
  ) => OuterTypeOfFunction<Args, Returns>
Returns ZodCatch<ZodFunction<Args, Returns>>
Inherited from ZodType.catch
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:89

default

default(
def: noUndefined<InnerTypeOfFunction<Args, Returns>>,
): ZodDefault<ZodFunction<Args, Returns>>
Parameters
- def: noUndefined<InnerTypeOfFunction<Args, Returns>>
Returns ZodDefault<ZodFunction<Args, Returns>>
Inherited from ZodType.default
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:85
default(
def: () => noUndefined<InnerTypeOfFunction<Args, Returns>>,
): ZodDefault<ZodFunction<Args, Returns>>
Parameters
- def: () => noUndefined<InnerTypeOfFunction<Args, Returns>>
Returns ZodDefault<ZodFunction<Args, Returns>>
Inherited from ZodType.default
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:86

describe

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

implement

implement<F extends (...args: any[any]) => Returns["_input"]>(
    func: F,
): ReturnType<F> extends Returns["_output"]
    ? (...args: Args["_input"]) => ReturnType<ReturnType<F>>
    : OuterTypeOfFunction<Args, Returns>
Type Parameters
- F extends (...args: any[any]) => Returns["_input"]
Parameters
- func: F
Returns ReturnType<F> extends Returns["_output"]
? (...args: Args["_input"]) => ReturnType<ReturnType<F>>
: OuterTypeOfFunction<Args, Returns>
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:733

isNullable

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

isOptional

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

nullable

nullable(): ZodNullable<ZodFunction<Args, Returns>>
Returns ZodNullable<ZodFunction<Args, Returns>>
Inherited from ZodType.nullable
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:78

nullish

nullish(): ZodOptional<ZodNullable<ZodFunction<Args, Returns>>>
Returns ZodOptional<ZodNullable<ZodFunction<Args, Returns>>>
Inherited from ZodType.nullish
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:79

optional

optional(): ZodOptional<ZodFunction<Args, Returns>>
Returns ZodOptional<ZodFunction<Args, Returns>>
Inherited from ZodType.optional
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:77

or

or<T extends ZodType<any, any, any, T>>(
option: T,
): ZodUnion<[ZodFunction<Args, Returns>, T]>
Type Parameters
- T extends ZodType<any, any, any, T>
Parameters
- option: T
Returns ZodUnion<[ZodFunction<Args, Returns>, T]>
Inherited from ZodType.or
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:82

parameters

parameters(): Args
Returns Args
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:729

parse

parse(
data: unknown,
params?: Partial<ParseParams>,
): OuterTypeOfFunction<Args, Returns>
Parameters
- data: unknown
- Optionalparams: Partial<ParseParams>
Returns OuterTypeOfFunction<Args, Returns>
Inherited from ZodType.parse
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:62

parseAsync

parseAsync(
data: unknown,
params?: Partial<ParseParams>,
): Promise<OuterTypeOfFunction<Args, Returns>>
Parameters
- data: unknown
- Optionalparams: Partial<ParseParams>
Returns Promise<OuterTypeOfFunction<Args, Returns>>
Inherited from ZodType.parseAsync
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:64

pipe

pipe<T extends ZodType<any, any, any, T>>(
target: T,
): ZodPipeline<ZodFunction<Args, Returns>, T>
Type Parameters
- T extends ZodType<any, any, any, T>
Parameters
- target: T
Returns ZodPipeline<ZodFunction<Args, Returns>, T>
Inherited from ZodType.pipe
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:94

promise

promise(): ZodPromise<ZodFunction<Args, Returns>>
Returns ZodPromise<ZodFunction<Args, Returns>>
Inherited from ZodType.promise
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:81

readonly

readonly(): ZodReadonly<ZodFunction<Args, Returns>>
Returns ZodReadonly<ZodFunction<Args, Returns>>
Inherited from ZodType.readonly
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:95

refine

refine<RefinedOutput extends (...args: any[any]) => Returns["_output"]>(
    check: (arg: OuterTypeOfFunction<Args, Returns>) => arg is RefinedOutput,
    message?:
        | string
        | Partial<Omit<ZodCustomIssue, "code">>
        | (
            arg: OuterTypeOfFunction<Args, Returns>,
        ) => Partial<Omit<ZodCustomIssue, "code">>,
): ZodEffects<
    ZodFunction<Args, Returns>,
    RefinedOutput,
    InnerTypeOfFunction<Args, Returns>,
>
Type Parameters
- RefinedOutput extends (...args: any[any]) => Returns["_output"]
Parameters
- check: (arg: OuterTypeOfFunction<Args, Returns>) => arg is RefinedOutput
- Optionalmessage:
      | string
      | Partial<Omit<ZodCustomIssue, "code">>
      | (
          arg: OuterTypeOfFunction<Args, Returns>,
      ) => Partial<Omit<ZodCustomIssue, "code">>
Returns ZodEffects<
    ZodFunction<Args, Returns>,
    RefinedOutput,
    InnerTypeOfFunction<Args, Returns>,
>
Inherited from ZodType.refine
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:68
refine(
    check: (arg: OuterTypeOfFunction<Args, Returns>) => unknown,
    message?:
        | string
        | Partial<Omit<ZodCustomIssue, "code">>
        | (
            arg: OuterTypeOfFunction<Args, Returns>,
        ) => Partial<Omit<ZodCustomIssue, "code">>,
): ZodEffects<
    ZodFunction<Args, Returns>,
    OuterTypeOfFunction<Args, Returns>,
    InnerTypeOfFunction<Args, Returns>,
>
Parameters
- check: (arg: OuterTypeOfFunction<Args, Returns>) => unknown
- Optionalmessage:
      | string
      | Partial<Omit<ZodCustomIssue, "code">>
      | (
          arg: OuterTypeOfFunction<Args, Returns>,
      ) => Partial<Omit<ZodCustomIssue, "code">>
Returns ZodEffects<
    ZodFunction<Args, Returns>,
    OuterTypeOfFunction<Args, Returns>,
    InnerTypeOfFunction<Args, Returns>,
>
Inherited from ZodType.refine
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:69

refinement

refinement<RefinedOutput extends (...args: any[any]) => Returns["_output"]>(
    check: (arg: OuterTypeOfFunction<Args, Returns>) => arg is RefinedOutput,
    refinementData:
        | IssueData
        | (
            arg: OuterTypeOfFunction<Args, Returns>,
            ctx: RefinementCtx,
        ) => IssueData,
): ZodEffects<
    ZodFunction<Args, Returns>,
    RefinedOutput,
    InnerTypeOfFunction<Args, Returns>,
>
Type Parameters
- RefinedOutput extends (...args: any[any]) => Returns["_output"]
Parameters
- check: (arg: OuterTypeOfFunction<Args, Returns>) => arg is RefinedOutput
- refinementData:
      | IssueData
      | (
          arg: OuterTypeOfFunction<Args, Returns>,
          ctx: RefinementCtx,
      ) => IssueData
Returns ZodEffects<
    ZodFunction<Args, Returns>,
    RefinedOutput,
    InnerTypeOfFunction<Args, Returns>,
>
Inherited from ZodType.refinement
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:70
refinement(
    check: (arg: OuterTypeOfFunction<Args, Returns>) => boolean,
    refinementData:
        | IssueData
        | (
            arg: OuterTypeOfFunction<Args, Returns>,
            ctx: RefinementCtx,
        ) => IssueData,
): ZodEffects<
    ZodFunction<Args, Returns>,
    OuterTypeOfFunction<Args, Returns>,
    InnerTypeOfFunction<Args, Returns>,
>
Parameters
- check: (arg: OuterTypeOfFunction<Args, Returns>) => boolean
- refinementData:
      | IssueData
      | (
          arg: OuterTypeOfFunction<Args, Returns>,
          ctx: RefinementCtx,
      ) => IssueData
Returns ZodEffects<
    ZodFunction<Args, Returns>,
    OuterTypeOfFunction<Args, Returns>,
    InnerTypeOfFunction<Args, Returns>,
>
Inherited from ZodType.refinement
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:71

returns

returns<NewReturnType extends ZodType<any, any, any, NewReturnType>>(
returnType: NewReturnType,
): ZodFunction<Args, NewReturnType>
Type Parameters
- NewReturnType extends ZodType<any, any, any, NewReturnType>
Parameters
- returnType: NewReturnType
Returns ZodFunction<Args, NewReturnType>
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:732

returnType

returnType(): Returns
Returns Returns
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:730

safeParse

safeParse(
    data: unknown,
    params?: Partial<ParseParams>,
): SafeParseReturnType<
    InnerTypeOfFunction<Args, Returns>,
    OuterTypeOfFunction<Args, Returns>,
>
Parameters
- data: unknown
- Optionalparams: Partial<ParseParams>
Returns SafeParseReturnType<
InnerTypeOfFunction<Args, Returns>,
OuterTypeOfFunction<Args, Returns>,
>
Inherited from ZodType.safeParse
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:63

safeParseAsync

safeParseAsync(
    data: unknown,
    params?: Partial<ParseParams>,
): Promise<
    SafeParseReturnType<
        InnerTypeOfFunction<Args, Returns>,
        OuterTypeOfFunction<Args, Returns>,
    >,
>
Parameters
- data: unknown
- Optionalparams: Partial<ParseParams>
Returns Promise<
    SafeParseReturnType<
        InnerTypeOfFunction<Args, Returns>,
        OuterTypeOfFunction<Args, Returns>,
    >,
>
Inherited from ZodType.safeParseAsync
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:65

strictImplement

strictImplement(
func: InnerTypeOfFunction<Args, Returns>,
): InnerTypeOfFunction<Args, Returns>
Parameters
- func: InnerTypeOfFunction<Args, Returns>
Returns InnerTypeOfFunction<Args, Returns>
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:734

superRefine

superRefine<RefinedOutput extends (...args: any[any]) => Returns["_output"]>(
    refinement: (
        arg: OuterTypeOfFunction<Args, Returns>,
        ctx: RefinementCtx,
    ) => arg is RefinedOutput,
): ZodEffects<
    ZodFunction<Args, Returns>,
    RefinedOutput,
    InnerTypeOfFunction<Args, Returns>,
>
Type Parameters
- RefinedOutput extends (...args: any[any]) => Returns["_output"]
Parameters
- refinement: (
  arg: OuterTypeOfFunction<Args, Returns>,
  ctx: RefinementCtx,
  ) => arg is RefinedOutput
Returns ZodEffects<
    ZodFunction<Args, Returns>,
    RefinedOutput,
    InnerTypeOfFunction<Args, Returns>,
>
Inherited from ZodType.superRefine
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:73
superRefine(
    refinement: (
        arg: OuterTypeOfFunction<Args, Returns>,
        ctx: RefinementCtx,
    ) => void,
): ZodEffects<
    ZodFunction<Args, Returns>,
    OuterTypeOfFunction<Args, Returns>,
    InnerTypeOfFunction<Args, Returns>,
>
Parameters
- refinement: (arg: OuterTypeOfFunction<Args, Returns>, ctx: RefinementCtx) => void
Returns ZodEffects<
    ZodFunction<Args, Returns>,
    OuterTypeOfFunction<Args, Returns>,
    InnerTypeOfFunction<Args, Returns>,
>
Inherited from ZodType.superRefine
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:74
superRefine(
    refinement: (
        arg: OuterTypeOfFunction<Args, Returns>,
        ctx: RefinementCtx,
    ) => Promise<void>,
): ZodEffects<
    ZodFunction<Args, Returns>,
    OuterTypeOfFunction<Args, Returns>,
    InnerTypeOfFunction<Args, Returns>,
>
Parameters
- refinement: (arg: OuterTypeOfFunction<Args, Returns>, ctx: RefinementCtx) => Promise<void>
Returns ZodEffects<
    ZodFunction<Args, Returns>,
    OuterTypeOfFunction<Args, Returns>,
    InnerTypeOfFunction<Args, Returns>,
>
Inherited from ZodType.superRefine
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:75

transform

transform<NewOut>(
    transform: (
        arg: OuterTypeOfFunction<Args, Returns>,
        ctx: RefinementCtx,
    ) => NewOut | Promise<NewOut>,
): ZodEffects<
    ZodFunction<Args, Returns>,
    NewOut,
    InnerTypeOfFunction<Args, Returns>,
>
Type Parameters
- NewOut
Parameters
- transform: (
  arg: OuterTypeOfFunction<Args, Returns>,
  ctx: RefinementCtx,
  ) => NewOut | Promise<NewOut>
Returns ZodEffects<
    ZodFunction<Args, Returns>,
    NewOut,
    InnerTypeOfFunction<Args, Returns>,
>
Inherited from ZodType.transform
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:84

`Static`create

create(): ZodFunction<ZodTuple<[], ZodUnknown>, ZodUnknown>
Returns ZodFunction<ZodTuple<[], ZodUnknown>, ZodUnknown>
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:736
create<
    T extends
        ZodTuple<[] | [ZodTypeAny, ...ZodTypeAny[]], null | ZodTypeAny, T> = ZodTuple<
        [],
        ZodUnknown,
    >,
>(
    args: T,
): ZodFunction<T, ZodUnknown>
Type Parameters
- T extends ZodTuple<[] | [ZodTypeAny, ...ZodTypeAny[]], null | ZodTypeAny, T> = ZodTuple<[], ZodUnknown>
Parameters
- args: T
Returns ZodFunction<T, ZodUnknown>
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:737
create<
    T extends
        ZodTuple<[] | [ZodTypeAny, ...ZodTypeAny[]], null | ZodTypeAny, T>,
    U extends ZodType<any, any, any, U>,
>(
    args: T,
    returns: U,
): ZodFunction<T, U>
Type Parameters
- T extends ZodTuple<[] | [ZodTypeAny, ...ZodTypeAny[]], null | ZodTypeAny, T>
- U extends ZodType<any, any, any, U>
Parameters
- args: T
- returns: U
Returns ZodFunction<T, U>
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:738
create<
    T extends
        ZodTuple<[] | [ZodTypeAny, ...ZodTypeAny[]], null | ZodTypeAny, T> = ZodTuple<
        [],
        ZodUnknown,
    >,
    U extends ZodType<any, any, any, U> = ZodUnknown,
>(
    args: T,
    returns: U,
    params?: RawCreateParams,
): ZodFunction<T, U>
Type Parameters
- T extends ZodTuple<[] | [ZodTypeAny, ...ZodTypeAny[]], null | ZodTypeAny, T> = ZodTuple<[], ZodUnknown>
- U extends ZodType<any, any, any, U> = ZodUnknown
Parameters
- args: T
- returns: U
- Optionalparams: RawCreateParams
Returns ZodFunction<T, U>
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:739

Class ZodFunction<Args, Returns>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ZodFunction<Args, Returns>

Properties

Readonly_def

Readonly_input

Readonly_output

Readonly_type

spa

validate

Accessors

description

Returns undefined | string

Methods

_getOrReturnCtx

Parameters

Returns ParseContext

_getType

Parameters

Returns string

_parse

Parameters

Returns ParseReturnType<any>

_parseAsync

Parameters

Returns AsyncParseReturnType<OuterTypeOfFunction<Args, Returns>>

_parseSync

Parameters

Returns SyncParseReturnType<OuterTypeOfFunction<Args, Returns>>

_processInputParams

Parameters

Returns { ctx: ParseContext; status: ParseStatus }

_refinement

Parameters

Returns ZodEffects< ZodFunction<Args, Returns>, OuterTypeOfFunction<Args, Returns>, InnerTypeOfFunction<Args, Returns>,>

and

Type Parameters

Parameters

Returns ZodIntersection<ZodFunction<Args, Returns>, T>

args

Type Parameters

Parameters

Returns ZodFunction<ZodTuple<Items, ZodUnknown>, Returns>

array

Returns ZodArray<ZodFunction<Args, Returns>, "many">

brand

Type Parameters

Parameters

Returns ZodBranded<ZodFunction<Args, Returns>, B>

catch

Parameters

Returns ZodCatch<ZodFunction<Args, Returns>>

Parameters

Returns ZodCatch<ZodFunction<Args, Returns>>

default

Parameters

Returns ZodDefault<ZodFunction<Args, Returns>>

Parameters

Returns ZodDefault<ZodFunction<Args, Returns>>

describe

Parameters

Returns this

implement

Type Parameters

Parameters

Returns ReturnType<F> extends Returns["_output"] ? (...args: Args["_input"]) => ReturnType<ReturnType<F>> : OuterTypeOfFunction<Args, Returns>

isNullable

Returns boolean

isOptional

Returns boolean

`Readonly`_def

`Readonly`_input

`Readonly`_output

`Readonly`_type

Returns ZodEffects<
ZodFunction<Args, Returns>,
OuterTypeOfFunction<Args, Returns>,
InnerTypeOfFunction<Args, Returns>,
>

Returns ReturnType<F> extends Returns["_output"]
? (...args: Args["_input"]) => ReturnType<ReturnType<F>>
: OuterTypeOfFunction<Args, Returns>

Returns ZodEffects<
ZodFunction<Args, Returns>,
RefinedOutput,
InnerTypeOfFunction<Args, Returns>,
>

Returns ZodEffects<
ZodFunction<Args, Returns>,
OuterTypeOfFunction<Args, Returns>,
InnerTypeOfFunction<Args, Returns>,
>

Returns ZodEffects<
ZodFunction<Args, Returns>,
RefinedOutput,
InnerTypeOfFunction<Args, Returns>,
>

Returns ZodEffects<
ZodFunction<Args, Returns>,
OuterTypeOfFunction<Args, Returns>,
InnerTypeOfFunction<Args, Returns>,
>

Returns SafeParseReturnType<
InnerTypeOfFunction<Args, Returns>,
OuterTypeOfFunction<Args, Returns>,
>

Returns Promise<
SafeParseReturnType<
InnerTypeOfFunction<Args, Returns>,
OuterTypeOfFunction<Args, Returns>,
>,
>

Returns ZodEffects<
ZodFunction<Args, Returns>,
RefinedOutput,
InnerTypeOfFunction<Args, Returns>,
>

Returns ZodEffects<
ZodFunction<Args, Returns>,
OuterTypeOfFunction<Args, Returns>,
InnerTypeOfFunction<Args, Returns>,
>

Returns ZodEffects<
ZodFunction<Args, Returns>,
OuterTypeOfFunction<Args, Returns>,
InnerTypeOfFunction<Args, Returns>,
>

Returns ZodEffects<
ZodFunction<Args, Returns>,
NewOut,
InnerTypeOfFunction<Args, Returns>,
>

`Static`create