Class ZodPromise<T>

Type Parameters

T extends ZodTypeAny

Hierarchy-Diagram

Legend

class

abstract class

public property

public method

underlined static property/method

italic abstract property/method

Hierarchy (view full)

ZodType<Promise<T["_output"]>, ZodPromiseDef<T>, Promise<T["_input"]>>
- ZodPromise

Index

Constructors

constructor

new ZodPromise<T extends ZodTypeAny>(def: ZodPromiseDef<T>): ZodPromise<T>
Type Parameters
- T extends ZodTypeAny
Parameters
- def: ZodPromiseDef<T>
Returns ZodPromise<T>
Inherited from ZodType.constructor
- Defined in node_modules/zod/lib/types.d.ts:76

Properties

`Readonly` _def

_def: ZodPromiseDef<T>

`Readonly` _input

_input: Promise<T["_input"]>

`Readonly` _output

_output: Promise<T["_output"]>

`Readonly` _type

_type: Promise<T["_output"]>

spa

spa: ((data: unknown, params?: Partial<ParseParams>) => Promise<SafeParseReturnType<Promise<T["_input"]>, Promise<T["_output"]>>>)

Alias of safeParseAsync

Type declaration

- (data: unknown, params?: Partial<ParseParams>): Promise<SafeParseReturnType<Promise<T["_input"]>, Promise<T["_output"]>>>
- Parameters
  - data: unknown
  - Optional params: Partial<ParseParams>
  Returns Promise<SafeParseReturnType<Promise<T["_input"]>, Promise<T["_output"]>>>

`Static` create

create: (<T_1 extends ZodTypeAny>(schema: T_1, params?: RawCreateParams) => ZodPromise<T_1>)

Type declaration

- <T_1 extends ZodTypeAny>(schema: T_1, params?: RawCreateParams): ZodPromise<T_1>
- Type Parameters
  - T_1 extends ZodTypeAny
  Parameters
  - schema: T_1
  - Optional params: RawCreateParams
  Returns ZodPromise<T_1>

Accessors

description

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

Methods

_getOrReturnCtx

_getOrReturnCtx(input: ParseInput, ctx?: ParseContext): ParseContext
Parameters
- input: ParseInput
- Optional ctx: ParseContext
Returns ParseContext
Inherited from ZodType._getOrReturnCtx
- Defined in 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/zod/lib/types.d.ts:54

_parse

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

_parseAsync

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

_parseSync

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

_processInputParams

_processInputParams(input: ParseInput): {
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:56

_refinement

_refinement(refinement: ((arg: Promise<T["_output"]>, ctx: RefinementCtx) => any)): ZodEffects<ZodPromise<T>, Promise<T["_output"]>, Promise<T["_input"]>>
Parameters
- refinement: ((arg: Promise<T["_output"]>, ctx: RefinementCtx) => any)
  - - (arg: Promise<T["_output"]>, ctx: RefinementCtx): any
    - Parameters
      arg: Promise<T["_output"]>
      ctx: RefinementCtx
      Returns any
Returns ZodEffects<ZodPromise<T>, Promise<T["_output"]>, Promise<T["_input"]>>
Inherited from ZodType._refinement
- Defined in node_modules/zod/lib/types.d.ts:72

and

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

array

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

brand

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

catch

catch(def: Promise<T["_output"]>): ZodCatch<ZodPromise<T>>
Parameters
- def: Promise<T["_output"]>
Returns ZodCatch<ZodPromise<T>>
Inherited from ZodType.catch
- Defined in node_modules/zod/lib/types.d.ts:88
catch(def: ((ctx: {
error: ZodError<any>;
input: Promise<T["_input"]>;
}) => Promise<T["_output"]>)): ZodCatch<ZodPromise<T>>
Parameters
- def: ((ctx: {
  error: ZodError<any>;
  input: Promise<T["_input"]>;
  }) => Promise<T["_output"]>)
  - - (ctx: {
      error: ZodError<any>;
      input: Promise<T["_input"]>;
      }): Promise<T["_output"]>
    - Parameters
      ctx: {
      error: ZodError<any>;
      input: Promise<T["_input"]>;
      }
      error: ZodError<any>
      input: Promise<T["_input"]>
      Returns Promise<T["_output"]>
Returns ZodCatch<ZodPromise<T>>
Inherited from ZodType.catch
- Defined in node_modules/zod/lib/types.d.ts:89

default

default(def: Promise<T["_input"]>): ZodDefault<ZodPromise<T>>
Parameters
- def: Promise<T["_input"]>
Returns ZodDefault<ZodPromise<T>>
Inherited from ZodType.default
- Defined in node_modules/zod/lib/types.d.ts:85
default(def: (() => Promise<T["_input"]>)): ZodDefault<ZodPromise<T>>
Parameters
- def: (() => Promise<T["_input"]>)
  - - (): Promise<T["_input"]>
    - Returns Promise<T["_input"]>
Returns ZodDefault<ZodPromise<T>>
Inherited from ZodType.default
- Defined in 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/zod/lib/types.d.ts:93

isNullable

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

isOptional

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

nullable

nullable(): ZodNullable<ZodPromise<T>>
Returns ZodNullable<ZodPromise<T>>
Inherited from ZodType.nullable
- Defined in node_modules/zod/lib/types.d.ts:78

nullish

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

optional

optional(): ZodOptional<ZodPromise<T>>
Returns ZodOptional<ZodPromise<T>>
Inherited from ZodType.optional
- Defined in node_modules/zod/lib/types.d.ts:77

or

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

parse

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

parseAsync

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

pipe

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

promise

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

readonly

readonly(): ZodReadonly<ZodPromise<T>>
Returns ZodReadonly<ZodPromise<T>>
Inherited from ZodType.readonly
- Defined in node_modules/zod/lib/types.d.ts:95

refine

refine<RefinedOutput extends Promise<T["_output"]>>(check: ((arg: Promise<T["_output"]>) => arg is RefinedOutput), message?: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: Promise<T["_output"]>) => Partial<Omit<ZodCustomIssue, "code">>)): ZodEffects<ZodPromise<T>, RefinedOutput, Promise<T["_input"]>>
Type Parameters
- RefinedOutput extends Promise<T["_output"]>
Parameters
- check: ((arg: Promise<T["_output"]>) => arg is RefinedOutput)
  - - (arg: Promise<T["_output"]>): arg is RefinedOutput
    - Parameters
      arg: Promise<T["_output"]>
      Returns arg is RefinedOutput
- Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: Promise<T["_output"]>) => Partial<Omit<ZodCustomIssue, "code">>)
Returns ZodEffects<ZodPromise<T>, RefinedOutput, Promise<T["_input"]>>
Inherited from ZodType.refine
- Defined in node_modules/zod/lib/types.d.ts:68
refine(check: ((arg: Promise<T["_output"]>) => unknown), message?: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: Promise<T["_output"]>) => Partial<Omit<ZodCustomIssue, "code">>)): ZodEffects<ZodPromise<T>, Promise<T["_output"]>, Promise<T["_input"]>>
Parameters
- check: ((arg: Promise<T["_output"]>) => unknown)
  - - (arg: Promise<T["_output"]>): unknown
    - Parameters
      arg: Promise<T["_output"]>
      Returns unknown
- Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: Promise<T["_output"]>) => Partial<Omit<ZodCustomIssue, "code">>)
Returns ZodEffects<ZodPromise<T>, Promise<T["_output"]>, Promise<T["_input"]>>
Inherited from ZodType.refine
- Defined in node_modules/zod/lib/types.d.ts:69

refinement

refinement<RefinedOutput extends Promise<T["_output"]>>(check: ((arg: Promise<T["_output"]>) => arg is RefinedOutput), refinementData: IssueData | ((arg: Promise<T["_output"]>, ctx: RefinementCtx) => IssueData)): ZodEffects<ZodPromise<T>, RefinedOutput, Promise<T["_input"]>>
Type Parameters
- RefinedOutput extends Promise<T["_output"]>
Parameters
- check: ((arg: Promise<T["_output"]>) => arg is RefinedOutput)
  - - (arg: Promise<T["_output"]>): arg is RefinedOutput
    - Parameters
      arg: Promise<T["_output"]>
      Returns arg is RefinedOutput
- refinementData: IssueData | ((arg: Promise<T["_output"]>, ctx: RefinementCtx) => IssueData)
Returns ZodEffects<ZodPromise<T>, RefinedOutput, Promise<T["_input"]>>
Inherited from ZodType.refinement
- Defined in node_modules/zod/lib/types.d.ts:70
refinement(check: ((arg: Promise<T["_output"]>) => boolean), refinementData: IssueData | ((arg: Promise<T["_output"]>, ctx: RefinementCtx) => IssueData)): ZodEffects<ZodPromise<T>, Promise<T["_output"]>, Promise<T["_input"]>>
Parameters
- check: ((arg: Promise<T["_output"]>) => boolean)
  - - (arg: Promise<T["_output"]>): boolean
    - Parameters
      arg: Promise<T["_output"]>
      Returns boolean
- refinementData: IssueData | ((arg: Promise<T["_output"]>, ctx: RefinementCtx) => IssueData)
Returns ZodEffects<ZodPromise<T>, Promise<T["_output"]>, Promise<T["_input"]>>
Inherited from ZodType.refinement
- Defined in node_modules/zod/lib/types.d.ts:71

safeParse

safeParse(data: unknown, params?: Partial<ParseParams>): SafeParseReturnType<Promise<T["_input"]>, Promise<T["_output"]>>
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns SafeParseReturnType<Promise<T["_input"]>, Promise<T["_output"]>>
Inherited from ZodType.safeParse
- Defined in node_modules/zod/lib/types.d.ts:63

safeParseAsync

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

superRefine

superRefine<RefinedOutput extends Promise<T["_output"]>>(refinement: ((arg: Promise<T["_output"]>, ctx: RefinementCtx) => arg is RefinedOutput)): ZodEffects<ZodPromise<T>, RefinedOutput, Promise<T["_input"]>>
Type Parameters
- RefinedOutput extends Promise<T["_output"]>
Parameters
- refinement: ((arg: Promise<T["_output"]>, ctx: RefinementCtx) => arg is RefinedOutput)
  - - (arg: Promise<T["_output"]>, ctx: RefinementCtx): arg is RefinedOutput
    - Parameters
      arg: Promise<T["_output"]>
      ctx: RefinementCtx
      Returns arg is RefinedOutput
Returns ZodEffects<ZodPromise<T>, RefinedOutput, Promise<T["_input"]>>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/lib/types.d.ts:73
superRefine(refinement: ((arg: Promise<T["_output"]>, ctx: RefinementCtx) => void)): ZodEffects<ZodPromise<T>, Promise<T["_output"]>, Promise<T["_input"]>>
Parameters
- refinement: ((arg: Promise<T["_output"]>, ctx: RefinementCtx) => void)
  - - (arg: Promise<T["_output"]>, ctx: RefinementCtx): void
    - Parameters
      arg: Promise<T["_output"]>
      ctx: RefinementCtx
      Returns void
Returns ZodEffects<ZodPromise<T>, Promise<T["_output"]>, Promise<T["_input"]>>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/lib/types.d.ts:74
superRefine(refinement: ((arg: Promise<T["_output"]>, ctx: RefinementCtx) => Promise<void>)): ZodEffects<ZodPromise<T>, Promise<T["_output"]>, Promise<T["_input"]>>
Parameters
- refinement: ((arg: Promise<T["_output"]>, ctx: RefinementCtx) => Promise<void>)
  - - (arg: Promise<T["_output"]>, ctx: RefinementCtx): Promise<void>
    - Parameters
      arg: Promise<T["_output"]>
      ctx: RefinementCtx
      Returns Promise<void>
Returns ZodEffects<ZodPromise<T>, Promise<T["_output"]>, Promise<T["_input"]>>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/lib/types.d.ts:75

transform

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

unwrap

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

Class ZodPromise<T>

Type Parameters

Hierarchy-Diagram

Legend

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ZodPromise<T>

Properties

Readonly _def

Readonly _input

Readonly _output

Readonly _type

spa

Type declaration

Parameters

Returns Promise<SafeParseReturnType<Promise<T["_input"]>, Promise<T["_output"]>>>

Static create

Type declaration

Type Parameters

Parameters

Returns ZodPromise<T_1>

Accessors

description

Returns undefined | string

Methods

_getOrReturnCtx

Parameters

Returns ParseContext

_getType

Parameters

Returns string

_parse

Parameters

Returns ParseReturnType<Promise<T["_output"]>>

_parseAsync

Parameters

Returns AsyncParseReturnType<Promise<T["_output"]>>

_parseSync

Parameters

Returns SyncParseReturnType<Promise<T["_output"]>>

_processInputParams

Parameters

Returns { ctx: ParseContext; status: ParseStatus; }

ctx: ParseContext

status: ParseStatus

_refinement

Parameters

Parameters

Returns any

Returns ZodEffects<ZodPromise<T>, Promise<T["_output"]>, Promise<T["_input"]>>

and

Type Parameters

Parameters

Returns ZodIntersection<ZodPromise<T>, T>

array

Returns ZodArray<ZodPromise<T>, "many">

brand

Type Parameters

Parameters

Returns ZodBranded<ZodPromise<T>, B>

catch

Parameters

Returns ZodCatch<ZodPromise<T>>

Parameters

Parameters

error: ZodError<any>

input: Promise<T["_input"]>

Returns Promise<T["_output"]>

Returns ZodCatch<ZodPromise<T>>

default

Parameters

Returns ZodDefault<ZodPromise<T>>

`Readonly` _def

`Readonly` _input

`Readonly` _output

`Readonly` _type

`Static` create

Returns {
ctx: ParseContext;
status: ParseStatus;
}