Class ZodFunction<Args, Returns>

Type Parameters

Args extends Zod.z.ZodTuple<any, any>
Returns extends Zod.z.ZodTypeAny

Hierarchy (View Summary)

Zod.z.ZodType<
    Zod.z.OuterTypeOfFunction<Args, Returns>,
    Zod.z.ZodFunctionDef<Args, Returns>,
    Zod.z.InnerTypeOfFunction<Args, Returns>,
>
- ZodFunction

Index

Constructors

constructor

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

Properties

spa

spa: (
    data: unknown,
    params?: Partial<Zod.z.ParseParams>,
) => Promise<
    Zod.z.SafeParseReturnType<
        Zod.z.InnerTypeOfFunction<Args, Returns>,
        Zod.z.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>>
    : Zod.z.OuterTypeOfFunction<Args, Returns>

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<any>
Parameters
- input: Zod.z.ParseInput
Returns Zod.z.ParseReturnType<any>
Overrides ZodType._parse
- Defined in node_modules/zod/lib/types.d.ts:684

_parseAsync

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

_parseSync

_parseSync(
input: Zod.z.ParseInput,
): Zod.z.SyncParseReturnType<Zod.z.OuterTypeOfFunction<Args, Returns>>
Parameters
- input: Zod.z.ParseInput
Returns Zod.z.SyncParseReturnType<Zod.z.OuterTypeOfFunction<Args, Returns>>
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: Zod.z.OuterTypeOfFunction<Args, Returns>,
        ctx: Zod.z.RefinementCtx,
    ) => any,
): Zod.z.ZodEffects<
    Zod.z.ZodFunction<Args, Returns>,
    Zod.z.OuterTypeOfFunction<Args, Returns>,
    Zod.z.InnerTypeOfFunction<Args, Returns>,
>
Parameters
- refinement: (arg: Zod.z.OuterTypeOfFunction<Args, Returns>, ctx: Zod.z.RefinementCtx) => any
Returns Zod.z.ZodEffects<
    Zod.z.ZodFunction<Args, Returns>,
    Zod.z.OuterTypeOfFunction<Args, Returns>,
    Zod.z.InnerTypeOfFunction<Args, Returns>,
>
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.ZodFunction<Args, Returns>, T>
Type Parameters
- T extends Zod.z.ZodTypeAny
Parameters
- incoming: T
Returns Zod.z.ZodIntersection<Zod.z.ZodFunction<Args, Returns>, T>
Inherited from ZodType.and
- Defined in node_modules/zod/lib/types.d.ts:80

args

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

array

array(): Zod.z.ZodArray<Zod.z.ZodFunction<Args, Returns>, "many">
Returns Zod.z.ZodArray<Zod.z.ZodFunction<Args, Returns>, "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.ZodFunction<Args, Returns>, B>
Type Parameters
- B extends string | number | symbol
Parameters
- Optionalbrand: B
Returns Zod.z.ZodBranded<Zod.z.ZodFunction<Args, Returns>, B>
Inherited from ZodType.brand
- Defined in node_modules/zod/lib/types.d.ts:84

catch

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

default

default(
def: noUndefined<Zod.z.InnerTypeOfFunction<Args, Returns>>,
): Zod.z.ZodDefault<Zod.z.ZodFunction<Args, Returns>>
Parameters
- def: noUndefined<Zod.z.InnerTypeOfFunction<Args, Returns>>
Returns Zod.z.ZodDefault<Zod.z.ZodFunction<Args, Returns>>
Inherited from ZodType.default
- Defined in node_modules/zod/lib/types.d.ts:82
default(
def: () => noUndefined<Zod.z.InnerTypeOfFunction<Args, Returns>>,
): Zod.z.ZodDefault<Zod.z.ZodFunction<Args, Returns>>
Parameters
- def: () => noUndefined<Zod.z.InnerTypeOfFunction<Args, Returns>>
Returns Zod.z.ZodDefault<Zod.z.ZodFunction<Args, Returns>>
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

implement

implement<F extends (...args: any[any]) => Returns["_input"]>(
    func: F,
): ReturnType<F> extends Returns["_output"]
    ? (...args: Args["_input"]) => ReturnType<ReturnType<F>>
    : Zod.z.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>>
: Zod.z.OuterTypeOfFunction<Args, Returns>
- Defined in node_modules/zod/lib/types.d.ts:689

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.ZodFunction<Args, Returns>>
Returns Zod.z.ZodNullable<Zod.z.ZodFunction<Args, Returns>>
Inherited from ZodType.nullable
- Defined in node_modules/zod/lib/types.d.ts:75

nullish

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

optional

optional(): Zod.z.ZodOptional<Zod.z.ZodFunction<Args, Returns>>
Returns Zod.z.ZodOptional<Zod.z.ZodFunction<Args, Returns>>
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.ZodFunction<Args, Returns>, T]>
Type Parameters
- T extends Zod.z.ZodTypeAny
Parameters
- option: T
Returns Zod.z.ZodUnion<[Zod.z.ZodFunction<Args, Returns>, T]>
Inherited from ZodType.or
- Defined in node_modules/zod/lib/types.d.ts:79

parameters

parameters(): Args
Returns Args
- Defined in node_modules/zod/lib/types.d.ts:685

parse

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

parseAsync

parseAsync(
data: unknown,
params?: Partial<Zod.z.ParseParams>,
): Promise<Zod.z.OuterTypeOfFunction<Args, Returns>>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.z.ParseParams>
Returns Promise<Zod.z.OuterTypeOfFunction<Args, Returns>>
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.ZodFunction<Args, Returns>, T>
Type Parameters
- T extends Zod.z.ZodTypeAny
Parameters
- target: T
Returns Zod.z.ZodPipeline<Zod.z.ZodFunction<Args, Returns>, T>
Inherited from ZodType.pipe
- Defined in node_modules/zod/lib/types.d.ts:91

promise

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

readonly

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

refine

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

refinement

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

returns

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

returnType

returnType(): Returns
Returns Returns
- Defined in node_modules/zod/lib/types.d.ts:686

safeParse

safeParse(
    data: unknown,
    params?: Partial<Zod.z.ParseParams>,
): Zod.z.SafeParseReturnType<
    Zod.z.InnerTypeOfFunction<Args, Returns>,
    Zod.z.OuterTypeOfFunction<Args, Returns>,
>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.z.ParseParams>
Returns Zod.z.SafeParseReturnType<
Zod.z.InnerTypeOfFunction<Args, Returns>,
Zod.z.OuterTypeOfFunction<Args, Returns>,
>
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<
        Zod.z.InnerTypeOfFunction<Args, Returns>,
        Zod.z.OuterTypeOfFunction<Args, Returns>,
    >,
>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.z.ParseParams>
Returns Promise<
    Zod.z.SafeParseReturnType<
        Zod.z.InnerTypeOfFunction<Args, Returns>,
        Zod.z.OuterTypeOfFunction<Args, Returns>,
    >,
>
Inherited from ZodType.safeParseAsync
- Defined in node_modules/zod/lib/types.d.ts:62

strictImplement

strictImplement(
func: Zod.z.InnerTypeOfFunction<Args, Returns>,
): Zod.z.InnerTypeOfFunction<Args, Returns>
Parameters
- func: Zod.z.InnerTypeOfFunction<Args, Returns>
Returns Zod.z.InnerTypeOfFunction<Args, Returns>
- Defined in node_modules/zod/lib/types.d.ts:690

superRefine

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

transform

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

`Static`create

create(): Zod.z.ZodFunction<
Zod.z.ZodTuple<[], Zod.z.ZodUnknown>,
Zod.z.ZodUnknown,
>
Returns Zod.z.ZodFunction<Zod.z.ZodTuple<[], Zod.z.ZodUnknown>, Zod.z.ZodUnknown>
- Defined in node_modules/zod/lib/types.d.ts:692
create<T extends Zod.z.AnyZodTuple = Zod.z.ZodTuple<[], Zod.z.ZodUnknown>>(
args: T,
): Zod.z.ZodFunction<T, Zod.z.ZodUnknown>
Type Parameters
- T extends Zod.z.AnyZodTuple = Zod.z.ZodTuple<[], Zod.z.ZodUnknown>
Parameters
- args: T
Returns Zod.z.ZodFunction<T, Zod.z.ZodUnknown>
- Defined in node_modules/zod/lib/types.d.ts:693
create<T extends Zod.z.AnyZodTuple, U extends Zod.z.ZodTypeAny>(
args: T,
returns: U,
): Zod.z.ZodFunction<T, U>
Type Parameters
- T extends Zod.z.AnyZodTuple
- U extends Zod.z.ZodTypeAny
Parameters
- args: T
- returns: U
Returns Zod.z.ZodFunction<T, U>
- Defined in node_modules/zod/lib/types.d.ts:694
create<
    T extends Zod.z.AnyZodTuple = Zod.z.ZodTuple<[], Zod.z.ZodUnknown>,
    U extends Zod.z.ZodTypeAny = Zod.z.ZodUnknown,
>(
    args: T,
    returns: U,
    params?: Zod.z.RawCreateParams,
): Zod.z.ZodFunction<T, U>
Type Parameters
- T extends Zod.z.AnyZodTuple = Zod.z.ZodTuple<[], Zod.z.ZodUnknown>
- U extends Zod.z.ZodTypeAny = Zod.z.ZodUnknown
Parameters
- args: T
- returns: U
- Optionalparams: Zod.z.RawCreateParams
Returns Zod.z.ZodFunction<T, U>
- Defined in node_modules/zod/lib/types.d.ts:695

Class ZodFunction<Args, Returns>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Zod.z.ZodFunction<Args, Returns>

Properties

Readonly_def

Readonly_input

Readonly_output

Readonly_type

spa

validate

Accessors

description

Returns undefined | string

Methods

_getOrReturnCtx

Parameters

Returns Zod.z.ParseContext

_getType

Parameters

Returns string

_parse

Parameters

Returns Zod.z.ParseReturnType<any>

_parseAsync

Parameters

Returns Zod.z.AsyncParseReturnType<Zod.z.OuterTypeOfFunction<Args, Returns>>

_parseSync

Parameters

Returns Zod.z.SyncParseReturnType<Zod.z.OuterTypeOfFunction<Args, Returns>>

_processInputParams

Parameters

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

_refinement

Parameters

Returns Zod.z.ZodEffects< Zod.z.ZodFunction<Args, Returns>, Zod.z.OuterTypeOfFunction<Args, Returns>, Zod.z.InnerTypeOfFunction<Args, Returns>,>

and

Type Parameters

Parameters

Returns Zod.z.ZodIntersection<Zod.z.ZodFunction<Args, Returns>, T>

args

Type Parameters

Parameters

Returns Zod.z.ZodFunction<Zod.z.ZodTuple<Items, Zod.z.ZodUnknown>, Returns>

array

Returns Zod.z.ZodArray<Zod.z.ZodFunction<Args, Returns>, "many">

brand

Type Parameters

Parameters

Returns Zod.z.ZodBranded<Zod.z.ZodFunction<Args, Returns>, B>

catch

Parameters

Returns Zod.z.ZodCatch<Zod.z.ZodFunction<Args, Returns>>

Parameters

Returns Zod.z.ZodCatch<Zod.z.ZodFunction<Args, Returns>>

default

Parameters

Returns Zod.z.ZodDefault<Zod.z.ZodFunction<Args, Returns>>

Parameters

Returns Zod.z.ZodDefault<Zod.z.ZodFunction<Args, Returns>>

describe

Parameters

Returns this

implement

Type Parameters

Parameters

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

isNullable

Returns boolean

isOptional

Returns boolean

`Readonly`_def

`Readonly`_input

`Readonly`_output

`Readonly`_type

Returns Zod.z.ZodEffects<
Zod.z.ZodFunction<Args, Returns>,
Zod.z.OuterTypeOfFunction<Args, Returns>,
Zod.z.InnerTypeOfFunction<Args, Returns>,
>

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

Returns Zod.z.ZodEffects<
Zod.z.ZodFunction<Args, Returns>,
RefinedOutput,
Zod.z.InnerTypeOfFunction<Args, Returns>,
>

Returns Zod.z.ZodEffects<
Zod.z.ZodFunction<Args, Returns>,
Zod.z.OuterTypeOfFunction<Args, Returns>,
Zod.z.InnerTypeOfFunction<Args, Returns>,
>

Returns Zod.z.ZodEffects<
Zod.z.ZodFunction<Args, Returns>,
RefinedOutput,
Zod.z.InnerTypeOfFunction<Args, Returns>,
>

Returns Zod.z.ZodEffects<
Zod.z.ZodFunction<Args, Returns>,
Zod.z.OuterTypeOfFunction<Args, Returns>,
Zod.z.InnerTypeOfFunction<Args, Returns>,
>

Returns Zod.z.SafeParseReturnType<
Zod.z.InnerTypeOfFunction<Args, Returns>,
Zod.z.OuterTypeOfFunction<Args, Returns>,
>

Returns Promise<
Zod.z.SafeParseReturnType<
Zod.z.InnerTypeOfFunction<Args, Returns>,
Zod.z.OuterTypeOfFunction<Args, Returns>,
>,
>

Returns Zod.z.ZodEffects<
Zod.z.ZodFunction<Args, Returns>,
RefinedOutput,
Zod.z.InnerTypeOfFunction<Args, Returns>,
>

Returns Zod.z.ZodEffects<
Zod.z.ZodFunction<Args, Returns>,
Zod.z.OuterTypeOfFunction<Args, Returns>,
Zod.z.InnerTypeOfFunction<Args, Returns>,
>

Returns Zod.z.ZodEffects<
Zod.z.ZodFunction<Args, Returns>,
Zod.z.OuterTypeOfFunction<Args, Returns>,
Zod.z.InnerTypeOfFunction<Args, Returns>,
>

Returns Zod.z.ZodEffects<
Zod.z.ZodFunction<Args, Returns>,
NewOut,
Zod.z.InnerTypeOfFunction<Args, Returns>,
>

`Static`create