Class ZodEffects<T, Output, Input>

Type Parameters

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

Hierarchy (View Summary)

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

Index

Constructors

constructor

new ZodEffects<
    T extends Zod.ZodTypeAny,
    Output = Zod.output<T>,
    Input = Zod.input<T>,
>(
    def: Zod.ZodEffectsDef,
): Zod.ZodEffects<T, Output, Input>
Type Parameters
- T extends Zod.ZodTypeAny
- Output = Zod.output<T>
- Input = Zod.input<T>
Parameters
- def: Zod.ZodEffectsDef
Returns Zod.ZodEffects<T, Output, Input>
Inherited from ZodType.constructor

Properties

`Readonly`_def

_def: Zod.ZodEffectsDef

`Readonly`_input

_input: Input

`Readonly`_output

_output: Output

`Readonly`_type

_type: Output

spa

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

Alias of safeParseAsync

`Static`create

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

`Static`createWithPreprocess

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

Accessors

description

get description(): undefined | string
Returns undefined | string
Inherited from ZodType.description

Methods

_getOrReturnCtx

_getOrReturnCtx(input: Zod.ParseInput, ctx?: Zod.ParseContext): Zod.ParseContext
Parameters
- input: Zod.ParseInput
- Optionalctx: Zod.ParseContext
Returns Zod.ParseContext
Inherited from ZodType._getOrReturnCtx

_getType

_getType(input: Zod.ParseInput): string
Parameters
- input: Zod.ParseInput
Returns string
Inherited from ZodType._getType

_processInputParams

_processInputParams(
input: Zod.ParseInput,
): { ctx: Zod.ParseContext; status: Zod.ParseStatus }
Parameters
- input: Zod.ParseInput
Returns { ctx: Zod.ParseContext; status: Zod.ParseStatus }
Inherited from ZodType._processInputParams

_refinement

_refinement(
refinement: (arg: Output, ctx: Zod.RefinementCtx) => any,
): Zod.ZodEffects<Zod.ZodEffects<T, Output, Input>, Output, Input>
Parameters
- refinement: (arg: Output, ctx: Zod.RefinementCtx) => any
Returns Zod.ZodEffects<Zod.ZodEffects<T, Output, Input>, Output, Input>
Inherited from ZodType._refinement

and

and<T extends Zod.ZodTypeAny>(
incoming: T,
): Zod.ZodIntersection<Zod.ZodEffects<T, Output, Input>, T>
Type Parameters
- T extends Zod.ZodTypeAny
Parameters
- incoming: T
Returns Zod.ZodIntersection<Zod.ZodEffects<T, Output, Input>, T>
Inherited from ZodType.and

array

array(): Zod.ZodArray<Zod.ZodEffects<T, Output, Input>>
Returns Zod.ZodArray<Zod.ZodEffects<T, Output, Input>>
Inherited from ZodType.array

brand

brand<B extends string | number | symbol>(
brand?: B,
): Zod.ZodBranded<Zod.ZodEffects<T, Output, Input>, B>
Type Parameters
- B extends string | number | symbol
Parameters
- Optionalbrand: B
Returns Zod.ZodBranded<Zod.ZodEffects<T, Output, Input>, B>
Inherited from ZodType.brand

catch

catch(def: Output): Zod.ZodCatch<Zod.ZodEffects<T, Output, Input>>
Parameters
- def: Output
Returns Zod.ZodCatch<Zod.ZodEffects<T, Output, Input>>
Inherited from ZodType.catch
catch(
def: (ctx: { error: Zod.ZodError; input: Input }) => Output,
): Zod.ZodCatch<Zod.ZodEffects<T, Output, Input>>
Parameters
- def: (ctx: { error: Zod.ZodError; input: Input }) => Output
Returns Zod.ZodCatch<Zod.ZodEffects<T, Output, Input>>
Inherited from ZodType.catch

default

default(
def: noUndefined<Input>,
): Zod.ZodDefault<Zod.ZodEffects<T, Output, Input>>
Parameters
- def: noUndefined<Input>
Returns Zod.ZodDefault<Zod.ZodEffects<T, Output, Input>>
Inherited from ZodType.default
default(
def: () => noUndefined<Input>,
): Zod.ZodDefault<Zod.ZodEffects<T, Output, Input>>
Parameters
- def: () => noUndefined<Input>
Returns Zod.ZodDefault<Zod.ZodEffects<T, Output, Input>>
Inherited from ZodType.default

describe

describe(description: string): this
Parameters
- description: string
Returns this
Inherited from ZodType.describe

innerType

innerType(): T
Returns T

isNullable

isNullable(): boolean
Returns boolean
Inherited from ZodType.isNullable

isOptional

isOptional(): boolean
Returns boolean
Inherited from ZodType.isOptional

nullable

nullable(): Zod.ZodNullable<Zod.ZodEffects<T, Output, Input>>
Returns Zod.ZodNullable<Zod.ZodEffects<T, Output, Input>>
Inherited from ZodType.nullable

nullish

nullish(): Zod.ZodOptional<Zod.ZodNullable<Zod.ZodEffects<T, Output, Input>>>
Returns Zod.ZodOptional<Zod.ZodNullable<Zod.ZodEffects<T, Output, Input>>>
Inherited from ZodType.nullish

optional

optional(): Zod.ZodOptional<Zod.ZodEffects<T, Output, Input>>
Returns Zod.ZodOptional<Zod.ZodEffects<T, Output, Input>>
Inherited from ZodType.optional

or

or<T extends Zod.ZodTypeAny>(
option: T,
): Zod.ZodUnion<[Zod.ZodEffects<T, Output, Input>, T]>
Type Parameters
- T extends Zod.ZodTypeAny
Parameters
- option: T
Returns Zod.ZodUnion<[Zod.ZodEffects<T, Output, Input>, T]>
Inherited from ZodType.or

parse

parse(data: unknown, params?: Partial<Zod.ParseParams>): Output
Parameters
- data: unknown
- Optionalparams: Partial<Zod.ParseParams>
Returns Output
Inherited from ZodType.parse

parseAsync

parseAsync(data: unknown, params?: Partial<Zod.ParseParams>): Promise<Output>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.ParseParams>
Returns Promise<Output>
Inherited from ZodType.parseAsync

pipe

pipe<T extends Zod.ZodTypeAny>(
target: T,
): Zod.ZodPipeline<Zod.ZodEffects<T, Output, Input>, T>
Type Parameters
- T extends Zod.ZodTypeAny
Parameters
- target: T
Returns Zod.ZodPipeline<Zod.ZodEffects<T, Output, Input>, T>
Inherited from ZodType.pipe

promise

promise(): Zod.ZodPromise<Zod.ZodEffects<T, Output, Input>>
Returns Zod.ZodPromise<Zod.ZodEffects<T, Output, Input>>
Inherited from ZodType.promise

readonly

readonly(): Zod.ZodReadonly<Zod.ZodEffects<T, Output, Input>>
Returns Zod.ZodReadonly<Zod.ZodEffects<T, Output, Input>>
Inherited from ZodType.readonly

refine

refine<RefinedOutput>(
    check: (arg: Output) => arg is RefinedOutput,
    message?:
        | string
        | Partial<Omit<Zod.ZodCustomIssue, "code">>
        | ((arg: Output) => Zod.CustomErrorParams),
): Zod.ZodEffects<Zod.ZodEffects<T, Output, Input>, RefinedOutput, Input>
Type Parameters
- RefinedOutput
Parameters
- check: (arg: Output) => arg is RefinedOutput
- Optionalmessage:
      | string
      | Partial<Omit<Zod.ZodCustomIssue, "code">>
      | ((arg: Output) => Zod.CustomErrorParams)
Returns Zod.ZodEffects<Zod.ZodEffects<T, Output, Input>, RefinedOutput, Input>
Inherited from ZodType.refine
refine(
    check: (arg: Output) => unknown,
    message?:
        | string
        | Partial<Omit<Zod.ZodCustomIssue, "code">>
        | ((arg: Output) => Zod.CustomErrorParams),
): Zod.ZodEffects<Zod.ZodEffects<T, Output, Input>, Output, Input>
Parameters
- check: (arg: Output) => unknown
- Optionalmessage:
      | string
      | Partial<Omit<Zod.ZodCustomIssue, "code">>
      | ((arg: Output) => Zod.CustomErrorParams)
Returns Zod.ZodEffects<Zod.ZodEffects<T, Output, Input>, Output, Input>
Inherited from ZodType.refine

refinement<RefinedOutput>(
    check: (arg: Output) => arg is RefinedOutput,
    refinementData:
        | Zod.IssueData
        | ((arg: Output, ctx: Zod.RefinementCtx) => Zod.IssueData),
): Zod.ZodEffects<Zod.ZodEffects<T, Output, Input>, RefinedOutput, Input>
Type Parameters
- RefinedOutput
Parameters
- check: (arg: Output) => arg is RefinedOutput
- refinementData: Zod.IssueData | ((arg: Output, ctx: Zod.RefinementCtx) => Zod.IssueData)
Returns Zod.ZodEffects<Zod.ZodEffects<T, Output, Input>, RefinedOutput, Input>
Inherited from ZodType.refinement
refinement(
    check: (arg: Output) => boolean,
    refinementData:
        | Zod.IssueData
        | ((arg: Output, ctx: Zod.RefinementCtx) => Zod.IssueData),
): Zod.ZodEffects<Zod.ZodEffects<T, Output, Input>, Output, Input>
Parameters
- check: (arg: Output) => boolean
- refinementData: Zod.IssueData | ((arg: Output, ctx: Zod.RefinementCtx) => Zod.IssueData)
Returns Zod.ZodEffects<Zod.ZodEffects<T, Output, Input>, Output, Input>
Inherited from ZodType.refinement

safeParse

safeParse(
data: unknown,
params?: Partial<Zod.ParseParams>,
): Zod.SafeParseReturnType<Input, Output>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.ParseParams>
Returns Zod.SafeParseReturnType<Input, Output>
Inherited from ZodType.safeParse

safeParseAsync

safeParseAsync(
data: unknown,
params?: Partial<Zod.ParseParams>,
): Promise<Zod.SafeParseReturnType<Input, Output>>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.ParseParams>
Returns Promise<Zod.SafeParseReturnType<Input, Output>>
Inherited from ZodType.safeParseAsync

sourceType

sourceType(): T
Returns T

superRefine

superRefine<RefinedOutput>(
    refinement: (
        arg: Output,
        ctx: Zod.RefinementCtx,
    ) => arg is RefinedOutput,
): Zod.ZodEffects<Zod.ZodEffects<T, Output, Input>, RefinedOutput, Input>
Type Parameters
- RefinedOutput
Parameters
- refinement: (arg: Output, ctx: Zod.RefinementCtx) => arg is RefinedOutput
Returns Zod.ZodEffects<Zod.ZodEffects<T, Output, Input>, RefinedOutput, Input>
Inherited from ZodType.superRefine
superRefine(
refinement: (arg: Output, ctx: Zod.RefinementCtx) => void,
): Zod.ZodEffects<Zod.ZodEffects<T, Output, Input>, Output, Input>
Parameters
- refinement: (arg: Output, ctx: Zod.RefinementCtx) => void
Returns Zod.ZodEffects<Zod.ZodEffects<T, Output, Input>, Output, Input>
Inherited from ZodType.superRefine
superRefine(
refinement: (arg: Output, ctx: Zod.RefinementCtx) => Promise<void>,
): Zod.ZodEffects<Zod.ZodEffects<T, Output, Input>, Output, Input>
Parameters
- refinement: (arg: Output, ctx: Zod.RefinementCtx) => Promise<void>
Returns Zod.ZodEffects<Zod.ZodEffects<T, Output, Input>, Output, Input>
Inherited from ZodType.superRefine

transform

transform<NewOut>(
    transform: (
        arg: Output,
        ctx: Zod.RefinementCtx,
    ) => NewOut | Promise<NewOut>,
): Zod.ZodEffects<Zod.ZodEffects<T, Output, Input>, NewOut>
Type Parameters
- NewOut
Parameters
- transform: (arg: Output, ctx: Zod.RefinementCtx) => NewOut | Promise<NewOut>
Returns Zod.ZodEffects<Zod.ZodEffects<T, Output, Input>, NewOut>
Inherited from ZodType.transform

Class ZodEffects<T, Output, Input>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Zod.ZodEffects<T, Output, Input>

Properties

Readonly_def

Readonly_input

Readonly_output

Readonly_type

spa

Staticcreate

StaticcreateWithPreprocess

Accessors

description

Returns undefined | string

Methods

_getOrReturnCtx

Parameters

Returns Zod.ParseContext

_getType

Parameters

Returns string

_parse

Parameters

Returns Zod.ParseReturnType<Output>

_parseAsync

Parameters

Returns Zod.AsyncParseReturnType<Output>

_parseSync

Parameters

Returns Zod.SyncParseReturnType<Output>

_processInputParams

Parameters

Returns { ctx: Zod.ParseContext; status: Zod.ParseStatus }

_refinement

Parameters

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

and

Type Parameters

Parameters

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

array

Returns Zod.ZodArray<Zod.ZodEffects<T, Output, Input>>

brand

Type Parameters

Parameters

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

catch

Parameters

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

Parameters

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

default

Parameters

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

Parameters

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

describe

Parameters

Returns this

innerType

Returns T

isNullable

Returns boolean

isOptional

Returns boolean

nullable

Returns Zod.ZodNullable<Zod.ZodEffects<T, Output, Input>>

nullish

Returns Zod.ZodOptional<Zod.ZodNullable<Zod.ZodEffects<T, Output, Input>>>

optional

`Readonly`_def

`Readonly`_input

`Readonly`_output

`Readonly`_type

`Static`create

`Static`createWithPreprocess