Class ZodEffects<T, Output, Input>

Type Parameters

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

Hierarchy (view full)

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

Constructors

constructor

new ZodEffects<T, Output, Input>(def): 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/v3/types.d.cts:79

Properties

`Readonly`_def

_def: ZodEffectsDef<T>

`Readonly`_input

_input: Input

`Readonly`_output

_output: Output

`Readonly`_type

_type: Output

~standard

~standard: Props<Input, Output>

spa

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

Alias of safeParseAsync

`Static`create

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

`Static`createWithPreprocess

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

Accessors

description

get description(): undefined | string
Returns undefined | string
Inherited from ZodType.description
- Defined in node_modules/zod/v3/types.d.cts:53

Methods

_getOrReturnCtx

_getOrReturnCtx(input, ctx?): ParseContext
Parameters
- input: ParseInput
- Optionalctx: ParseContext
Returns ParseContext
Inherited from ZodType._getOrReturnCtx
- Defined in node_modules/zod/v3/types.d.cts:57

_getType

_getType(input): string
Parameters
- input: ParseInput
Returns string
Inherited from ZodType._getType
- Defined in node_modules/zod/v3/types.d.cts:56

_parse

_parse(input): ParseReturnType<Output>
Parameters
- input: ParseInput
Returns ParseReturnType<Output>
Overrides ZodType._parse
- Defined in node_modules/zod/v3/types.d.cts:819

_parseAsync

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

_parseSync

_parseSync(input): SyncParseReturnType<Output>
Parameters
- input: ParseInput
Returns SyncParseReturnType<Output>
Inherited from ZodType._parseSync
- Defined in node_modules/zod/v3/types.d.cts:62

_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/v3/types.d.cts:58

_refinement

_refinement(refinement): ZodEffects<ZodEffects<T, Output, Input>, Output, Input>
Parameters
- refinement: ((arg: Output, ctx: RefinementCtx) => any)
  - - (arg, ctx): 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/v3/types.d.cts:75

~validate

~validate(data): Result<Output> | Promise<Result<Output>>
Parameters
- data: unknown
Returns Result<Output> | Promise<Result<Output>>
Inherited from ZodType.~validate
- Defined in node_modules/zod/v3/types.d.cts:66

and

and<T>(incoming): 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/v3/types.d.cts:86

array

array(): ZodArray<ZodEffects<T, Output, Input>, "many">
Returns ZodArray<ZodEffects<T, Output, Input>, "many">
Inherited from ZodType.array
- Defined in node_modules/zod/v3/types.d.cts:83

brand

brand<B>(brand?): ZodBranded<ZodEffects<T, Output, Input>, B>
Type Parameters
- B extends string | number | symbol
Parameters
- Optionalbrand: B
Returns ZodBranded<ZodEffects<T, Output, Input>, B>
Inherited from ZodType.brand
- Defined in node_modules/zod/v3/types.d.cts:90

catch

catch(def): ZodCatch<ZodEffects<T, Output, Input>>
Parameters
- def: Output
Returns ZodCatch<ZodEffects<T, Output, Input>>
Inherited from ZodType.catch
- Defined in node_modules/zod/v3/types.d.cts:91
catch(def): ZodCatch<ZodEffects<T, Output, Input>>
Parameters
- def: ((ctx: {
  error: ZodError<any>;
  input: Input;
  }) => Output)
  - - (ctx): 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/v3/types.d.cts:92

default

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

describe

describe(description): this
Parameters
- description: string
Returns this
Inherited from ZodType.describe
- Defined in node_modules/zod/v3/types.d.cts:96

innerType

innerType(): T
Returns T
- Defined in node_modules/zod/v3/types.d.cts:817

isNullable

isNullable(): boolean
Returns boolean
Inherited from ZodType.isNullable
- Defined in node_modules/zod/v3/types.d.cts:100

isOptional

isOptional(): boolean
Returns boolean
Inherited from ZodType.isOptional
- Defined in node_modules/zod/v3/types.d.cts:99

nullable

nullable(): ZodNullable<ZodEffects<T, Output, Input>>
Returns ZodNullable<ZodEffects<T, Output, Input>>
Inherited from ZodType.nullable
- Defined in node_modules/zod/v3/types.d.cts:81

nullish

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

optional

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

or

or<T>(option): 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/v3/types.d.cts:85

parse

parse(data, params?): Output
Parameters
- data: unknown
- Optionalparams: InexactPartial<ParseParams>
Returns Output
Inherited from ZodType.parse
- Defined in node_modules/zod/v3/types.d.cts:64

parseAsync

parseAsync(data, params?): Promise<Output>
Parameters
- data: unknown
- Optionalparams: InexactPartial<ParseParams>
Returns Promise<Output>
Inherited from ZodType.parseAsync
- Defined in node_modules/zod/v3/types.d.cts:67

pipe

pipe<T>(target): 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/v3/types.d.cts:97

promise

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

readonly

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

refine

refine<RefinedOutput>(check, message?): ZodEffects<ZodEffects<T, Output, Input>, RefinedOutput, Input>
Type Parameters
- RefinedOutput
Parameters
- check: ((arg: Output) => arg is RefinedOutput)
  - - (arg): arg is RefinedOutput
    - Parameters
      arg: Output
      Returns arg is RefinedOutput
- Optionalmessage: 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/v3/types.d.cts:71
refine(check, message?): ZodEffects<ZodEffects<T, Output, Input>, Output, Input>
Parameters
- check: ((arg: Output) => unknown)
  - - (arg): unknown
    - Parameters
      arg: Output
      Returns unknown
- Optionalmessage: 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/v3/types.d.cts:72

refinement

refinement<RefinedOutput>(check, refinementData): ZodEffects<ZodEffects<T, Output, Input>, RefinedOutput, Input>
Type Parameters
- RefinedOutput
Parameters
- check: ((arg: Output) => arg is RefinedOutput)
  - - (arg): 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/v3/types.d.cts:73
refinement(check, refinementData): ZodEffects<ZodEffects<T, Output, Input>, Output, Input>
Parameters
- check: ((arg: Output) => boolean)
  - - (arg): 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/v3/types.d.cts:74

safeParse

safeParse(data, params?): SafeParseReturnType<Input, Output>
Parameters
- data: unknown
- Optionalparams: InexactPartial<ParseParams>
Returns SafeParseReturnType<Input, Output>
Inherited from ZodType.safeParse
- Defined in node_modules/zod/v3/types.d.cts:65

safeParseAsync

safeParseAsync(data, params?): Promise<SafeParseReturnType<Input, Output>>
Parameters
- data: unknown
- Optionalparams: InexactPartial<ParseParams>
Returns Promise<SafeParseReturnType<Input, Output>>
Inherited from ZodType.safeParseAsync
- Defined in node_modules/zod/v3/types.d.cts:68

sourceType

sourceType(): T
Returns T
- Defined in node_modules/zod/v3/types.d.cts:818

superRefine

superRefine<RefinedOutput>(refinement): ZodEffects<ZodEffects<T, Output, Input>, RefinedOutput, Input>
Type Parameters
- RefinedOutput
Parameters
- refinement: ((arg: Output, ctx: RefinementCtx) => arg is RefinedOutput)
  - - (arg, ctx): 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/v3/types.d.cts:76
superRefine(refinement): ZodEffects<ZodEffects<T, Output, Input>, Output, Input>
Parameters
- refinement: ((arg: Output, ctx: RefinementCtx) => void)
  - - (arg, ctx): 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/v3/types.d.cts:77
superRefine(refinement): ZodEffects<ZodEffects<T, Output, Input>, Output, Input>
Parameters
- refinement: ((arg: Output, ctx: RefinementCtx) => Promise<void>)
  - - (arg, ctx): 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/v3/types.d.cts:78

transform

transform<NewOut>(transform): ZodEffects<ZodEffects<T, Output, Input>, NewOut, Input>
Type Parameters
- NewOut
Parameters
- transform: ((arg: Output, ctx: RefinementCtx) => NewOut | Promise<NewOut>)
  - - (arg, ctx): 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/v3/types.d.cts:87

Class ZodEffects<T, Output, Input>

Type Parameters

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

~standard

spa

Staticcreate

StaticcreateWithPreprocess

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>

~validate

Parameters

Returns Result<Output> | Promise<Result<Output>>

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

error: ZodError<any>

input: Input

Returns Output

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

default

Parameters

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

Parameters

Returns noUndefined<Input>

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

describe

`Readonly`_def

`Readonly`_input

`Readonly`_output

`Readonly`_type

`Static`create

`Static`createWithPreprocess

Returns {
ctx: ParseContext;
status: ParseStatus;
}