Class ZodEffects<T, Output, Input>

Type Parameters

T extends ZodTypeAny
Output = output<T>
Input = input<T>

Hierarchy-Diagram

Legend

class

abstract class

public property

public method

underlined static property/method

italic abstract property/method

Hierarchy (view full)

ZodType<Output, ZodEffectsDef<T>, Input>
- ZodEffects

Index

Constructors

constructor

new ZodEffects<T extends ZodTypeAny, Output, Input>(def: ZodEffectsDef<T>): ZodEffects<T, Output, Input>
Type Parameters
- T extends ZodTypeAny
- Output = output<T>
- Input = input<T>
Parameters
- def: ZodEffectsDef<T>
Returns ZodEffects<T, Output, Input>
Inherited from ZodType.constructor
- Defined in node_modules/zod/lib/types.d.ts:76

Properties

`Readonly` _def

_def: ZodEffectsDef<T>

`Readonly` _input

_input: Input

`Readonly` _output

_output: Output

`Readonly` _type

_type: Output

spa

spa: ((data: unknown, params?: Partial<ParseParams>) => Promise<SafeParseReturnType<Input, Output>>)

Alias of safeParseAsync

Type declaration

- (data: unknown, params?: Partial<ParseParams>): Promise<SafeParseReturnType<Input, Output>>
- Parameters
  - data: unknown
  - Optional params: Partial<ParseParams>
  Returns Promise<SafeParseReturnType<Input, Output>>

`Static` create

create: (<I extends ZodTypeAny>(schema: I, effect: Effect<I["_output"]>, params?: RawCreateParams) => ZodEffects<I, I["_output"], input<I>>)

Type declaration

- <I extends ZodTypeAny>(schema: I, effect: Effect<I["_output"]>, params?: RawCreateParams): ZodEffects<I, I["_output"], input<I>>
- Type Parameters
  - I extends ZodTypeAny
  Parameters
  - schema: I
  - effect: Effect<I["_output"]>
  - Optional params: RawCreateParams
  Returns ZodEffects<I, I["_output"], input<I>>

`Static` createWithPreprocess

createWithPreprocess: (<I extends ZodTypeAny>(preprocess: ((arg: unknown, ctx: RefinementCtx) => unknown), schema: I, params?: RawCreateParams) => ZodEffects<I, I["_output"], unknown>)

Type declaration

- <I extends ZodTypeAny>(preprocess: ((arg: unknown, ctx: RefinementCtx) => unknown), schema: I, params?: RawCreateParams): ZodEffects<I, I["_output"], unknown>
- Type Parameters
  - I extends ZodTypeAny
  Parameters
  - preprocess: ((arg: unknown, ctx: RefinementCtx) => unknown)
    - (arg: unknown, ctx: RefinementCtx): unknown
      Parameters
      arg: unknown
      ctx: RefinementCtx
      Returns unknown
  - schema: I
  - Optional params: RawCreateParams
  Returns ZodEffects<I, I["_output"], unknown>

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

_parseAsync

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

_parseSync

_parseSync(input: ParseInput): SyncParseReturnType<Output>
Parameters
- input: ParseInput
Returns SyncParseReturnType<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: Output, ctx: RefinementCtx) => any)): ZodEffects<ZodEffects<T, Output, Input>, Output, Input>
Parameters
- refinement: ((arg: Output, ctx: RefinementCtx) => any)
  - - (arg: Output, ctx: RefinementCtx): any
    - Parameters
      arg: Output
      ctx: RefinementCtx
      Returns any
Returns ZodEffects<ZodEffects<T, Output, Input>, Output, Input>
Inherited from ZodType._refinement
- Defined in node_modules/zod/lib/types.d.ts:72

and

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

array

array(): ZodArray<ZodEffects<T, Output, Input>, "many">
Returns ZodArray<ZodEffects<T, Output, Input>, "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<ZodEffects<T, Output, Input>, B>
Type Parameters
- B extends string | number | symbol
Parameters
- Optional brand: B
Returns ZodBranded<ZodEffects<T, Output, Input>, B>
Inherited from ZodType.brand
- Defined in node_modules/zod/lib/types.d.ts:87

catch

catch(def: Output): ZodCatch<ZodEffects<T, Output, Input>>
Parameters
- def: Output
Returns ZodCatch<ZodEffects<T, Output, Input>>
Inherited from ZodType.catch
- Defined in node_modules/zod/lib/types.d.ts:88
catch(def: ((ctx: {
error: ZodError<any>;
input: Input;
}) => Output)): ZodCatch<ZodEffects<T, Output, Input>>
Parameters
- def: ((ctx: {
  error: ZodError<any>;
  input: Input;
  }) => Output)
  - - (ctx: {
      error: ZodError<any>;
      input: Input;
      }): Output
    - Parameters
      ctx: {
      error: ZodError<any>;
      input: Input;
      }
      error: ZodError<any>
      input: Input
      Returns Output
Returns ZodCatch<ZodEffects<T, Output, Input>>
Inherited from ZodType.catch
- Defined in node_modules/zod/lib/types.d.ts:89

default

default(def: noUndefined<Input>): ZodDefault<ZodEffects<T, Output, Input>>
Parameters
- def: noUndefined<Input>
Returns ZodDefault<ZodEffects<T, Output, Input>>
Inherited from ZodType.default
- Defined in node_modules/zod/lib/types.d.ts:85
default(def: (() => noUndefined<Input>)): ZodDefault<ZodEffects<T, Output, Input>>
Parameters
- def: (() => noUndefined<Input>)
  - - (): noUndefined<Input>
    - Returns noUndefined<Input>
Returns ZodDefault<ZodEffects<T, Output, Input>>
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

innerType

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

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<ZodEffects<T, Output, Input>>
Returns ZodNullable<ZodEffects<T, Output, Input>>
Inherited from ZodType.nullable
- Defined in node_modules/zod/lib/types.d.ts:78

nullish

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

optional

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

or

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

parse

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

parseAsync

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

pipe

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

promise

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

readonly

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

refine

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

refinement

refinement<RefinedOutput>(check: ((arg: Output) => arg is RefinedOutput), refinementData: IssueData | ((arg: Output, ctx: RefinementCtx) => IssueData)): ZodEffects<ZodEffects<T, Output, Input>, RefinedOutput, Input>
Type Parameters
- RefinedOutput
Parameters
- check: ((arg: Output) => arg is RefinedOutput)
  - - (arg: Output): arg is RefinedOutput
    - Parameters
      arg: Output
      Returns arg is RefinedOutput
- refinementData: IssueData | ((arg: Output, ctx: RefinementCtx) => IssueData)
Returns ZodEffects<ZodEffects<T, Output, Input>, RefinedOutput, Input>
Inherited from ZodType.refinement
- Defined in node_modules/zod/lib/types.d.ts:70
refinement(check: ((arg: Output) => boolean), refinementData: IssueData | ((arg: Output, ctx: RefinementCtx) => IssueData)): ZodEffects<ZodEffects<T, Output, Input>, Output, Input>
Parameters
- check: ((arg: Output) => boolean)
  - - (arg: Output): boolean
    - Parameters
      arg: Output
      Returns boolean
- refinementData: IssueData | ((arg: Output, ctx: RefinementCtx) => IssueData)
Returns ZodEffects<ZodEffects<T, Output, Input>, Output, Input>
Inherited from ZodType.refinement
- Defined in node_modules/zod/lib/types.d.ts:71

safeParse

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

safeParseAsync

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

sourceType

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

superRefine

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

transform

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

Class ZodEffects<T, Output, Input>

Type Parameters

Hierarchy-Diagram

Legend

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ZodEffects<T, Output, Input>

Properties

Readonly _def

Readonly _input

Readonly _output

Readonly _type

spa

Type declaration

Parameters

Returns Promise<SafeParseReturnType<Input, Output>>

Static create

Type declaration

Type Parameters

Parameters

Returns ZodEffects<I, I["_output"], input<I>>

Static createWithPreprocess

Type declaration

Type Parameters

Parameters

Parameters

Returns unknown

Returns ZodEffects<I, I["_output"], unknown>

Accessors

description

Returns undefined | string

Methods

_getOrReturnCtx

Parameters

Returns ParseContext

_getType

Parameters

Returns string

_parse

Parameters

Returns ParseReturnType<Output>

_parseAsync

Parameters

Returns AsyncParseReturnType<Output>

_parseSync

Parameters

Returns SyncParseReturnType<Output>

_processInputParams

Parameters

Returns { ctx: ParseContext; status: ParseStatus; }

ctx: ParseContext

status: ParseStatus

_refinement

Parameters

Parameters

Returns any

Returns ZodEffects<ZodEffects<T, Output, Input>, Output, Input>

and

Type Parameters

Parameters

Returns ZodIntersection<ZodEffects<T, Output, Input>, T>

array

Returns ZodArray<ZodEffects<T, Output, Input>, "many">

brand

Type Parameters

Parameters

Returns ZodBranded<ZodEffects<T, Output, Input>, B>

catch

Parameters

Returns ZodCatch<ZodEffects<T, Output, Input>>

Parameters

Parameters

`Readonly` _def

`Readonly` _input

`Readonly` _output

`Readonly` _type

`Static` create

`Static` createWithPreprocess

Returns {
ctx: ParseContext;
status: ParseStatus;
}