Class ZodFunction<Args, Returns>

Type Parameters

Args extends ZodTuple<any, any>
Returns extends ZodTypeAny

Hierarchy (view full)

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

Index

Constructors

constructor

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

Properties

Alias of safeParseAsync

Type declaration

- (data, params?): Promise<SafeParseReturnType<InnerTypeOfFunction<Args, Returns>, OuterTypeOfFunction<Args, Returns>>>
- Parameters
  - data: unknown
  - Optional params: Partial<ParseParams>
  Returns Promise<SafeParseReturnType<InnerTypeOfFunction<Args, Returns>, OuterTypeOfFunction<Args, Returns>>>

validate

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

Type declaration

- <F>(func): ReturnType<F> extends Returns["_output"]
  ? ((...args) => ReturnType)
  : OuterTypeOfFunction<Args, Returns>
- Type Parameters
  - F extends ((...args) => Returns["_input"])
  Parameters
  - func: F
  Returns ReturnType<F> extends Returns["_output"]
  ? ((...args) => ReturnType)
  : 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, ctx?): ParseContext
Parameters
- input: ParseInput
- Optional ctx: ParseContext
Returns ParseContext
Inherited from ZodType._getOrReturnCtx
- Defined in node_modules/zod/lib/types.d.ts:52

_getType

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

_parse

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

_parseAsync

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

_parseSync

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

_processInputParams

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

_refinement

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

and

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

args

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

array

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

brand

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

catch

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

default

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

describe

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

implement

implement<F>(func): ReturnType<F> extends Returns["_output"]
? ((...args) => ReturnType)
: OuterTypeOfFunction<Args, Returns>
Type Parameters
- F extends ((...args) => Returns["_input"])
Parameters
- func: F
Returns ReturnType<F> extends Returns["_output"]
? ((...args) => ReturnType)
: 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(): ZodNullable<ZodFunction<Args, Returns>>
Returns ZodNullable<ZodFunction<Args, Returns>>
Inherited from ZodType.nullable
- Defined in node_modules/zod/lib/types.d.ts:75

nullish

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

optional

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

or

or<T>(option): ZodUnion<[ZodFunction<Args, Returns>, T]>
Type Parameters
- T extends ZodTypeAny
Parameters
- option: T
Returns ZodUnion<[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, params?): OuterTypeOfFunction<Args, Returns>
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns OuterTypeOfFunction<Args, Returns>
Inherited from ZodType.parse
- Defined in node_modules/zod/lib/types.d.ts:59

parseAsync

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

pipe

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

promise

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

readonly

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

refine

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

refinement

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

returnType

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

returns

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

safeParse

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

safeParseAsync

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

strictImplement

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

superRefine

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

transform

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

`Static` create

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

Class ZodFunction<Args, Returns>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ZodFunction<Args, Returns>

Properties

Readonly _def

Readonly _input

Readonly _output

Readonly _type

spa

Type declaration

Parameters

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

validate

Type declaration

Type Parameters

Parameters

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

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; }

ctx: ParseContext

status: ParseStatus

_refinement

Parameters

Parameters

Returns any

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

Parameters

error: ZodError<any>

input: InnerTypeOfFunction<Args, Returns>

Returns OuterTypeOfFunction<Args, Returns>

Returns ZodCatch<ZodFunction<Args, Returns>>

default

`Readonly` _def

`Readonly` _input

`Readonly` _output

`Readonly` _type

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

Returns {
ctx: ParseContext;
status: ParseStatus;
}

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