Class ZodEffects<T, Output, Input>

Type Parameters

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

Hierarchy (View Summary)

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

Constructors

constructor

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

Properties

`Readonly`_type

_type: Output

`Readonly`_output

_output: Output

`Readonly`_input

_input: Input

`Readonly`_def

_def: ZodEffectsDef

~standard

"~standard": Props<Input, Output>

spa

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

Alias of safeParseAsync

`Static`create

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

`Static`createWithPreprocess

createWithPreprocess: <I extends ZodTypeAny>(
    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

_getType

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

_getOrReturnCtx

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

_processInputParams

_processInputParams(
input: ParseInput,
): { status: ParseStatus; ctx: ParseContext }
Parameters
- input: ParseInput
Returns { status: ParseStatus; ctx: ParseContext }
Inherited from ZodType._processInputParams
- Defined in ../../node_modules/zod/v3/types.d.cts:58

_parseSync

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

_parseAsync

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

parse

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

safeParse

safeParse(
data: unknown,
params?: InexactPartial<ParseParams>,
): 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

~validate

"~validate"(data: unknown): 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

parseAsync

parseAsync(data: unknown, params?: InexactPartial<ParseParams>): 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

safeParseAsync

safeParseAsync(
data: unknown,
params?: InexactPartial<ParseParams>,
): 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

refine

refine<RefinedOutput>(
    check: (arg: Output) => arg is RefinedOutput,
    message?:
        | string
        | Partial<Omit<ZodCustomIssue, "code">>
        | ((arg: Output) => CustomErrorParams),
): ZodEffects<ZodEffects<T, Output, Input>, RefinedOutput, Input>
Type Parameters
- RefinedOutput
Parameters
- check: (arg: Output) => arg is RefinedOutput
- Optionalmessage:
      | string
      | Partial<Omit<ZodCustomIssue, "code">>
      | ((arg: Output) => CustomErrorParams)
Returns ZodEffects<ZodEffects<T, Output, Input>, RefinedOutput, Input>
Inherited from ZodType.refine
- Defined in ../../node_modules/zod/v3/types.d.cts:71
refine(
    check: (arg: Output) => unknown,
    message?:
        | string
        | Partial<Omit<ZodCustomIssue, "code">>
        | ((arg: Output) => CustomErrorParams),
): ZodEffects<ZodEffects<T, Output, Input>, Output, Input>
Parameters
- check: (arg: Output) => unknown
- Optionalmessage:
      | string
      | Partial<Omit<ZodCustomIssue, "code">>
      | ((arg: Output) => CustomErrorParams)
Returns ZodEffects<ZodEffects<T, Output, Input>, Output, Input>
Inherited from ZodType.refine
- Defined in ../../node_modules/zod/v3/types.d.cts:72

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
- 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: (arg: Output) => boolean,
    refinementData:
        | IssueData
        | ((arg: Output, ctx: RefinementCtx) => IssueData),
): ZodEffects<ZodEffects<T, Output, Input>, Output, Input>
Parameters
- check: (arg: Output) => 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

_refinement

_refinement(
refinement: (arg: Output, ctx: RefinementCtx) => any,
): ZodEffects<ZodEffects<T, Output, Input>, Output, Input>
Parameters
- refinement: (arg: Output, ctx: RefinementCtx) => any
Returns ZodEffects<ZodEffects<T, Output, Input>, Output, Input>
Inherited from ZodType._refinement
- Defined in ../../node_modules/zod/v3/types.d.cts:75

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
Returns ZodEffects<ZodEffects<T, Output, Input>, RefinedOutput, Input>
Inherited from ZodType.superRefine
- Defined in ../../node_modules/zod/v3/types.d.cts:76
superRefine(
refinement: (arg: Output, ctx: RefinementCtx) => void,
): ZodEffects<ZodEffects<T, Output, Input>, Output, Input>
Parameters
- refinement: (arg: Output, ctx: RefinementCtx) => 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: (arg: Output, ctx: RefinementCtx) => Promise<void>,
): ZodEffects<ZodEffects<T, Output, Input>, Output, Input>
Parameters
- refinement: (arg: Output, ctx: RefinementCtx) => Promise<void>
Returns ZodEffects<ZodEffects<T, Output, Input>, Output, Input>
Inherited from ZodType.superRefine
- Defined in ../../node_modules/zod/v3/types.d.cts:78

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

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

array

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

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

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

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

transform

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

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/v3/types.d.cts:88
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/v3/types.d.cts:89

brand

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

describe

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

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

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

isOptional

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

isNullable

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

innerType

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

sourceType

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

_parse

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

Class ZodEffects<T, Output, Input>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ZodEffects<T, Output, Input>

Properties

Readonly_type

Readonly_output

Readonly_input

Readonly_def

~standard

spa

Staticcreate

StaticcreateWithPreprocess

Accessors

description

Returns undefined | string

Methods

_getType

Parameters

Returns string

_getOrReturnCtx

Parameters

Returns ParseContext

_processInputParams

Parameters

Returns { status: ParseStatus; ctx: ParseContext }

_parseSync

Parameters

Returns SyncParseReturnType<Output>

_parseAsync

Parameters

Returns AsyncParseReturnType<Output>

parse

Parameters

Returns Output

safeParse

Parameters

Returns SafeParseReturnType<Input, Output>

~validate

Parameters

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

parseAsync

Parameters

Returns Promise<Output>

safeParseAsync

Parameters

Returns Promise<SafeParseReturnType<Input, Output>>

refine

Type Parameters

Parameters

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

Parameters

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

refinement

Type Parameters

Parameters

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

Parameters

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

_refinement

Parameters

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

superRefine

Type Parameters

Parameters

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

Parameters

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

Parameters

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

optional

`Readonly`_type

`Readonly`_output

`Readonly`_input

`Readonly`_def

`Static`create

`Static`createWithPreprocess