Class ZodEffects<T, Output, Input>

Type Parameters

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

Hierarchy (View Summary)

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

Index

Constructors

constructor

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

Properties

`Readonly`_def

_def: Zod.z.ZodEffectsDef<T>

`Readonly`_input

_input: Input

`Readonly`_output

_output: Output

`Readonly`_type

_type: Output

spa

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

Alias of safeParseAsync

`Static`create

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

`Static`createWithPreprocess

createWithPreprocess: <I extends Zod.z.ZodTypeAny>(
    preprocess: (arg: unknown, ctx: Zod.z.RefinementCtx) => unknown,
    schema: I,
    params?: Zod.z.RawCreateParams,
) => Zod.z.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:49

Methods

_getOrReturnCtx

_getOrReturnCtx(
input: Zod.z.ParseInput,
ctx?: Zod.z.ParseContext,
): Zod.z.ParseContext
Parameters
- input: Zod.z.ParseInput
- Optionalctx: Zod.z.ParseContext
Returns Zod.z.ParseContext
Inherited from ZodType._getOrReturnCtx
- Defined in node_modules/zod/lib/types.d.ts:52

_getType

_getType(input: Zod.z.ParseInput): string
Parameters
- input: Zod.z.ParseInput
Returns string
Inherited from ZodType._getType
- Defined in node_modules/zod/lib/types.d.ts:51

_parse

_parse(input: Zod.z.ParseInput): Zod.z.ParseReturnType<Output>
Parameters
- input: Zod.z.ParseInput
Returns Zod.z.ParseReturnType<Output>
Overrides ZodType._parse
- Defined in node_modules/zod/lib/types.d.ts:787

_parseAsync

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

_parseSync

_parseSync(input: Zod.z.ParseInput): Zod.z.SyncParseReturnType<Output>
Parameters
- input: Zod.z.ParseInput
Returns Zod.z.SyncParseReturnType<Output>
Inherited from ZodType._parseSync
- Defined in node_modules/zod/lib/types.d.ts:57

_processInputParams

_processInputParams(
input: Zod.z.ParseInput,
): { ctx: Zod.z.ParseContext; status: Zod.z.ParseStatus }
Parameters
- input: Zod.z.ParseInput
Returns { ctx: Zod.z.ParseContext; status: Zod.z.ParseStatus }
Inherited from ZodType._processInputParams
- Defined in node_modules/zod/lib/types.d.ts:53

_refinement

_refinement(
refinement: (arg: Output, ctx: Zod.z.RefinementCtx) => any,
): Zod.z.ZodEffects<Zod.z.ZodEffects<T, Output, Input>, Output, Input>
Parameters
- refinement: (arg: Output, ctx: Zod.z.RefinementCtx) => any
Returns Zod.z.ZodEffects<Zod.z.ZodEffects<T, Output, Input>, Output, Input>
Inherited from ZodType._refinement
- Defined in node_modules/zod/lib/types.d.ts:69

and

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

array

array(): Zod.z.ZodArray<Zod.z.ZodEffects<T, Output, Input>, "many">
Returns Zod.z.ZodArray<Zod.z.ZodEffects<T, Output, Input>, "many">
Inherited from ZodType.array
- Defined in node_modules/zod/lib/types.d.ts:77

brand

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

catch

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

default

default(
def: noUndefined<Input>,
): Zod.z.ZodDefault<Zod.z.ZodEffects<T, Output, Input>>
Parameters
- def: noUndefined<Input>
Returns Zod.z.ZodDefault<Zod.z.ZodEffects<T, Output, Input>>
Inherited from ZodType.default
- Defined in node_modules/zod/lib/types.d.ts:82
default(
def: () => noUndefined<Input>,
): Zod.z.ZodDefault<Zod.z.ZodEffects<T, Output, Input>>
Parameters
- def: () => noUndefined<Input>
Returns Zod.z.ZodDefault<Zod.z.ZodEffects<T, Output, Input>>
Inherited from ZodType.default
- Defined in node_modules/zod/lib/types.d.ts:83

describe

describe(description: string): this
Parameters
- description: string
Returns this
Inherited from ZodType.describe
- Defined in node_modules/zod/lib/types.d.ts:90

innerType

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

isNullable

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

isOptional

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

nullable

nullable(): Zod.z.ZodNullable<Zod.z.ZodEffects<T, Output, Input>>
Returns Zod.z.ZodNullable<Zod.z.ZodEffects<T, Output, Input>>
Inherited from ZodType.nullable
- Defined in node_modules/zod/lib/types.d.ts:75

nullish

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

optional

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

or

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

parse

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

parseAsync

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

pipe

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

promise

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

readonly

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

refine

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

refinement

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

safeParse

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

safeParseAsync

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

sourceType

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

superRefine

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

transform

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

Class ZodEffects<T, Output, Input>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Zod.z.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.z.ParseContext

_getType

Parameters

Returns string

_parse

Parameters

Returns Zod.z.ParseReturnType<Output>

_parseAsync

Parameters

Returns Zod.z.AsyncParseReturnType<Output>

_parseSync

Parameters

Returns Zod.z.SyncParseReturnType<Output>

_processInputParams

Parameters

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

_refinement

Parameters

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

and

Type Parameters

Parameters

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

array

Returns Zod.z.ZodArray<Zod.z.ZodEffects<T, Output, Input>, "many">

brand

Type Parameters

Parameters

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

catch

Parameters

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

Parameters

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

default

Parameters

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

Parameters

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

describe

Parameters

Returns this

innerType

Returns T

isNullable

Returns boolean

isOptional

Returns boolean

nullable

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

nullish

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

optional

`Readonly`_def

`Readonly`_input

`Readonly`_output

`Readonly`_type

`Static`create

`Static`createWithPreprocess