Class ZodIntersection<T, U>

Type Parameters

T extends ZodTypeAny
U extends ZodTypeAny

Hierarchy (View Summary)

ZodType<
    T["_output"] & U["_output"],
    ZodIntersectionDef<T, U>,
    T["_input"] & U["_input"],
>
- ZodIntersection

Index

Constructors

constructor

new ZodIntersection<T extends ZodTypeAny, U extends ZodTypeAny>(
def: ZodIntersectionDef,
): ZodIntersection<T, U>
Type Parameters
- T extends ZodTypeAny
- U extends ZodTypeAny
Parameters
- def: ZodIntersectionDef
Returns ZodIntersection<T, U>
Inherited from ZodType.constructor
- Defined in ../../node_modules/zod/v3/types.d.cts:79

Properties

`Readonly`_type

_type: T["_output"] & U["_output"]

`Readonly`_output

_output: T["_output"] & U["_output"]

`Readonly`_input

_input: T["_input"] & U["_input"]

`Readonly`_def

_def: ZodIntersectionDef

~standard

"~standard": Props<T["_input"] & U["_input"], T["_output"] & U["_output"]>

spa

spa: (
    data: unknown,
    params?: InexactPartial<ParseParams>,
) => Promise<
    SafeParseReturnType<
        T["_input"] & U["_input"],
        T["_output"] & U["_output"],
    >,
>

Alias of safeParseAsync

`Static`create

create: <TSchema extends ZodTypeAny, USchema extends ZodTypeAny>(
    left: TSchema,
    right: USchema,
    params?: RawCreateParams,
) => ZodIntersection<TSchema, USchema>

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<T["_output"] & U["_output"]>
Parameters
- input: ParseInput
Returns SyncParseReturnType<T["_output"] & U["_output"]>
Inherited from ZodType._parseSync
- Defined in ../../node_modules/zod/v3/types.d.cts:62

_parseAsync

_parseAsync(
input: ParseInput,
): AsyncParseReturnType<T["_output"] & U["_output"]>
Parameters
- input: ParseInput
Returns AsyncParseReturnType<T["_output"] & U["_output"]>
Inherited from ZodType._parseAsync
- Defined in ../../node_modules/zod/v3/types.d.cts:63

parse

parse(
data: unknown,
params?: InexactPartial<ParseParams>,
): T["_output"] & U["_output"]
Parameters
- data: unknown
- Optionalparams: InexactPartial<ParseParams>
Returns T["_output"] & U["_output"]
Inherited from ZodType.parse
- Defined in ../../node_modules/zod/v3/types.d.cts:64

safeParse

safeParse(
    data: unknown,
    params?: InexactPartial<ParseParams>,
): SafeParseReturnType<
    T["_input"] & U["_input"],
    T["_output"] & U["_output"],
>
Parameters
- data: unknown
- Optionalparams: InexactPartial<ParseParams>
Returns SafeParseReturnType<T["_input"] & U["_input"], T["_output"] & U["_output"]>
Inherited from ZodType.safeParse
- Defined in ../../node_modules/zod/v3/types.d.cts:65

~validate

"~validate"(
    data: unknown,
):
    | Result<T["_output"] & U["_output"]>
    | Promise<Result<T["_output"] & U["_output"]>>
Parameters
- data: unknown
Returns
| Result<T["_output"] & U["_output"]>
| Promise<Result<T["_output"] & U["_output"]>>
Inherited from ZodType.~validate
- Defined in ../../node_modules/zod/v3/types.d.cts:66

parseAsync

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

safeParseAsync

safeParseAsync(
    data: unknown,
    params?: InexactPartial<ParseParams>,
): Promise<
    SafeParseReturnType<
        T["_input"] & U["_input"],
        T["_output"] & U["_output"],
    >,
>
Parameters
- data: unknown
- Optionalparams: InexactPartial<ParseParams>
Returns Promise<
    SafeParseReturnType<
        T["_input"] & U["_input"],
        T["_output"] & U["_output"],
    >,
>
Inherited from ZodType.safeParseAsync
- Defined in ../../node_modules/zod/v3/types.d.cts:68

refine

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

refinement<RefinedOutput extends any>(
    check: (arg: T["_output"] & U["_output"]) => arg is RefinedOutput,
    refinementData:
        | IssueData
        | ((arg: T["_output"] & U["_output"], ctx: RefinementCtx) => IssueData),
): ZodEffects<
    ZodIntersection<T, U>,
    RefinedOutput,
    T["_input"] & U["_input"],
>
Type Parameters
- RefinedOutput extends any
Parameters
- check: (arg: T["_output"] & U["_output"]) => arg is RefinedOutput
- refinementData:
  | IssueData
  | ((arg: T["_output"] & U["_output"], ctx: RefinementCtx) => IssueData)
Returns ZodEffects<ZodIntersection<T, U>, RefinedOutput, T["_input"] & U["_input"]>
Inherited from ZodType.refinement
- Defined in ../../node_modules/zod/v3/types.d.cts:73
refinement(
    check: (arg: T["_output"] & U["_output"]) => boolean,
    refinementData:
        | IssueData
        | ((arg: T["_output"] & U["_output"], ctx: RefinementCtx) => IssueData),
): ZodEffects<
    ZodIntersection<T, U>,
    T["_output"] & U["_output"],
    T["_input"] & U["_input"],
>
Parameters
- check: (arg: T["_output"] & U["_output"]) => boolean
- refinementData:
  | IssueData
  | ((arg: T["_output"] & U["_output"], ctx: RefinementCtx) => IssueData)
Returns ZodEffects<
    ZodIntersection<T, U>,
    T["_output"] & U["_output"],
    T["_input"] & U["_input"],
>
Inherited from ZodType.refinement
- Defined in ../../node_modules/zod/v3/types.d.cts:74

_refinement

_refinement(
    refinement: (
        arg: T["_output"] & U["_output"],
        ctx: RefinementCtx,
    ) => any,
): ZodEffects<
    ZodIntersection<T, U>,
    T["_output"] & U["_output"],
    T["_input"] & U["_input"],
>
Parameters
- refinement: (arg: T["_output"] & U["_output"], ctx: RefinementCtx) => any
Returns ZodEffects<
    ZodIntersection<T, U>,
    T["_output"] & U["_output"],
    T["_input"] & U["_input"],
>
Inherited from ZodType._refinement
- Defined in ../../node_modules/zod/v3/types.d.cts:75

superRefine

superRefine<RefinedOutput extends any>(
    refinement: (
        arg: T["_output"] & U["_output"],
        ctx: RefinementCtx,
    ) => arg is RefinedOutput,
): ZodEffects<
    ZodIntersection<T, U>,
    RefinedOutput,
    T["_input"] & U["_input"],
>
Type Parameters
- RefinedOutput extends any
Parameters
- refinement: (arg: T["_output"] & U["_output"], ctx: RefinementCtx) => arg is RefinedOutput
Returns ZodEffects<ZodIntersection<T, U>, RefinedOutput, T["_input"] & U["_input"]>
Inherited from ZodType.superRefine
- Defined in ../../node_modules/zod/v3/types.d.cts:76
superRefine(
    refinement: (
        arg: T["_output"] & U["_output"],
        ctx: RefinementCtx,
    ) => void,
): ZodEffects<
    ZodIntersection<T, U>,
    T["_output"] & U["_output"],
    T["_input"] & U["_input"],
>
Parameters
- refinement: (arg: T["_output"] & U["_output"], ctx: RefinementCtx) => void
Returns ZodEffects<
    ZodIntersection<T, U>,
    T["_output"] & U["_output"],
    T["_input"] & U["_input"],
>
Inherited from ZodType.superRefine
- Defined in ../../node_modules/zod/v3/types.d.cts:77
superRefine(
    refinement: (
        arg: T["_output"] & U["_output"],
        ctx: RefinementCtx,
    ) => Promise<void>,
): ZodEffects<
    ZodIntersection<T, U>,
    T["_output"] & U["_output"],
    T["_input"] & U["_input"],
>
Parameters
- refinement: (arg: T["_output"] & U["_output"], ctx: RefinementCtx) => Promise<void>
Returns ZodEffects<
    ZodIntersection<T, U>,
    T["_output"] & U["_output"],
    T["_input"] & U["_input"],
>
Inherited from ZodType.superRefine
- Defined in ../../node_modules/zod/v3/types.d.cts:78

optional

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

nullable

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

nullish

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

array

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

promise

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

or

or<T extends ZodTypeAny>(option: T): ZodUnion<[ZodIntersection<T, U>, T]>
Type Parameters
- T extends ZodTypeAny
Parameters
- option: T
Returns ZodUnion<[ZodIntersection<T, U>, T]>
Inherited from ZodType.or
- Defined in ../../node_modules/zod/v3/types.d.cts:85

and

and<T extends ZodTypeAny>(
incoming: T,
): ZodIntersection<ZodIntersection<T, U>, T>
Type Parameters
- T extends ZodTypeAny
Parameters
- incoming: T
Returns ZodIntersection<ZodIntersection<T, U>, T>
Inherited from ZodType.and
- Defined in ../../node_modules/zod/v3/types.d.cts:86

transform

transform<NewOut>(
    transform: (
        arg: T["_output"] & U["_output"],
        ctx: RefinementCtx,
    ) => NewOut | Promise<NewOut>,
): ZodEffects<ZodIntersection<T, U>, NewOut>
Type Parameters
- NewOut
Parameters
- transform: (
  arg: T["_output"] & U["_output"],
  ctx: RefinementCtx,
  ) => NewOut | Promise<NewOut>
Returns ZodEffects<ZodIntersection<T, U>, NewOut>
Inherited from ZodType.transform
- Defined in ../../node_modules/zod/v3/types.d.cts:87

default

default(
def: noUndefined<T["_input"] & U["_input"]>,
): ZodDefault<ZodIntersection<T, U>>
Parameters
- def: noUndefined<T["_input"] & U["_input"]>
Returns ZodDefault<ZodIntersection<T, U>>
Inherited from ZodType.default
- Defined in ../../node_modules/zod/v3/types.d.cts:88
default(
def: () => noUndefined<T["_input"] & U["_input"]>,
): ZodDefault<ZodIntersection<T, U>>
Parameters
- def: () => noUndefined<T["_input"] & U["_input"]>
Returns ZodDefault<ZodIntersection<T, U>>
Inherited from ZodType.default
- Defined in ../../node_modules/zod/v3/types.d.cts:89

brand

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

catch

catch(def: T["_output"] & U["_output"]): ZodCatch<ZodIntersection<T, U>>
Parameters
- def: T["_output"] & U["_output"]
Returns ZodCatch<ZodIntersection<T, U>>
Inherited from ZodType.catch
- Defined in ../../node_modules/zod/v3/types.d.cts:91
catch(
    def: (
        ctx: { error: ZodError; input: T["_input"] & U["_input"] },
    ) => T["_output"] & U["_output"],
): ZodCatch<ZodIntersection<T, U>>
Parameters
- def: (
  ctx: { error: ZodError; input: T["_input"] & U["_input"] },
  ) => T["_output"] & U["_output"]
Returns ZodCatch<ZodIntersection<T, U>>
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<ZodIntersection<T, U>, T>
Type Parameters
- T extends ZodTypeAny
Parameters
- target: T
Returns ZodPipeline<ZodIntersection<T, U>, T>
Inherited from ZodType.pipe
- Defined in ../../node_modules/zod/v3/types.d.cts:97

readonly

readonly(): ZodReadonly<ZodIntersection<T, U>>
Returns ZodReadonly<ZodIntersection<T, U>>
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

_parse

_parse(input: ParseInput): ParseReturnType<T["_output"] & U["_output"]>
Parameters
- input: ParseInput
Returns ParseReturnType<T["_output"] & U["_output"]>
Overrides ZodType._parse
- Defined in ../../node_modules/zod/v3/types.d.cts:635

Class ZodIntersection<T, U>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ZodIntersection<T, U>

Properties

Readonly_type

Readonly_output

Readonly_input

Readonly_def

~standard

spa

Staticcreate

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<T["_output"] & U["_output"]>

_parseAsync

Parameters

Returns AsyncParseReturnType<T["_output"] & U["_output"]>

parse

Parameters

Returns T["_output"] & U["_output"]

safeParse

Parameters

Returns SafeParseReturnType<T["_input"] & U["_input"], T["_output"] & U["_output"]>

~validate

Parameters

Returns | Result<T["_output"] & U["_output"]> | Promise<Result<T["_output"] & U["_output"]>>

parseAsync

Parameters

Returns Promise<T["_output"] & U["_output"]>

safeParseAsync

Parameters

Returns Promise< SafeParseReturnType< T["_input"] & U["_input"], T["_output"] & U["_output"], >,>

refine

Type Parameters

Parameters

Returns ZodEffects<ZodIntersection<T, U>, RefinedOutput, T["_input"] & U["_input"]>

Parameters

Returns ZodEffects< ZodIntersection<T, U>, T["_output"] & U["_output"], T["_input"] & U["_input"],>

refinement

Type Parameters

Parameters

Returns ZodEffects<ZodIntersection<T, U>, RefinedOutput, T["_input"] & U["_input"]>

Parameters

Returns ZodEffects< ZodIntersection<T, U>, T["_output"] & U["_output"], T["_input"] & U["_input"],>

_refinement

Parameters

Returns ZodEffects< ZodIntersection<T, U>, T["_output"] & U["_output"], T["_input"] & U["_input"],>

superRefine

Type Parameters

Parameters

Returns ZodEffects<ZodIntersection<T, U>, RefinedOutput, T["_input"] & U["_input"]>

Parameters

Returns ZodEffects< ZodIntersection<T, U>, T["_output"] & U["_output"], T["_input"] & U["_input"],>

Parameters

Returns ZodEffects< ZodIntersection<T, U>, T["_output"] & U["_output"], T["_input"] & U["_input"],>

optional

Returns ZodOptional<ZodIntersection<T, U>>

`Readonly`_type

`Readonly`_output

`Readonly`_input

`Readonly`_def

`Static`create

Returns
| Result<T["_output"] & U["_output"]>
| Promise<Result<T["_output"] & U["_output"]>>

Returns Promise<
SafeParseReturnType<
T["_input"] & U["_input"],
T["_output"] & U["_output"],
>,
>

Returns ZodEffects<
ZodIntersection<T, U>,
T["_output"] & U["_output"],
T["_input"] & U["_input"],
>

Returns ZodEffects<
ZodIntersection<T, U>,
T["_output"] & U["_output"],
T["_input"] & U["_input"],
>

Returns ZodEffects<
ZodIntersection<T, U>,
T["_output"] & U["_output"],
T["_input"] & U["_input"],
>

Returns ZodEffects<
ZodIntersection<T, U>,
T["_output"] & U["_output"],
T["_input"] & U["_input"],
>

Returns ZodEffects<
ZodIntersection<T, U>,
T["_output"] & U["_output"],
T["_input"] & U["_input"],
>