Class ZodSet<Value>

Type Parameters

Value extends Zod.z.ZodTypeAny = Zod.z.ZodTypeAny

Hierarchy (View Summary)

Zod.z.ZodType<
    Set<Value["_output"]>,
    Zod.z.ZodSetDef<Value>,
    Set<Value["_input"]>,
>
- ZodSet

Index

Constructors

constructor

new ZodSet<Value extends Zod.z.ZodTypeAny = Zod.z.ZodTypeAny>(
def: Zod.z.ZodSetDef<Value>,
): Zod.z.ZodSet<Value>
Type Parameters
- Value extends Zod.z.ZodTypeAny = Zod.z.ZodTypeAny
Parameters
- def: Zod.z.ZodSetDef<Value>
Returns Zod.z.ZodSet<Value>
Inherited from ZodType.constructor
- Defined in node_modules/zod/lib/types.d.ts:73

Properties

`Readonly`_def

_def: Zod.z.ZodSetDef<Value>

`Readonly`_input

_input: Set<Value["_input"]>

`Readonly`_output

_output: Set<Value["_output"]>

`Readonly`_type

_type: Set<Value["_output"]>

spa

spa: (
    data: unknown,
    params?: Partial<Zod.z.ParseParams>,
) => Promise<
    Zod.z.SafeParseReturnType<Set<Value["_input"]>, Set<Value["_output"]>>,
>

Alias of safeParseAsync

`Static`create

create: <Value_1 extends Zod.z.ZodTypeAny = Zod.z.ZodTypeAny>(
valueType: Value_1,
params?: Zod.z.RawCreateParams,
) => Zod.z.ZodSet<Value_1>

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<Set<Value["_output"]>>
Parameters
- input: Zod.z.ParseInput
Returns Zod.z.ParseReturnType<Set<Value["_output"]>>
Overrides ZodType._parse
- Defined in node_modules/zod/lib/types.d.ts:669

_parseAsync

_parseAsync(
input: Zod.z.ParseInput,
): Zod.z.AsyncParseReturnType<Set<Value["_output"]>>
Parameters
- input: Zod.z.ParseInput
Returns Zod.z.AsyncParseReturnType<Set<Value["_output"]>>
Inherited from ZodType._parseAsync
- Defined in node_modules/zod/lib/types.d.ts:58

_parseSync

_parseSync(
input: Zod.z.ParseInput,
): Zod.z.SyncParseReturnType<Set<Value["_output"]>>
Parameters
- input: Zod.z.ParseInput
Returns Zod.z.SyncParseReturnType<Set<Value["_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: Set<Value["_output"]>,
        ctx: Zod.z.RefinementCtx,
    ) => any,
): Zod.z.ZodEffects<
    Zod.z.ZodSet<Value>,
    Set<Value["_output"]>,
    Set<Value["_input"]>,
>
Parameters
- refinement: (arg: Set<Value["_output"]>, ctx: Zod.z.RefinementCtx) => any
Returns Zod.z.ZodEffects<
    Zod.z.ZodSet<Value>,
    Set<Value["_output"]>,
    Set<Value["_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.ZodSet<Value>, T>
Type Parameters
- T extends Zod.z.ZodTypeAny
Parameters
- incoming: T
Returns Zod.z.ZodIntersection<Zod.z.ZodSet<Value>, T>
Inherited from ZodType.and
- Defined in node_modules/zod/lib/types.d.ts:80

array

array(): Zod.z.ZodArray<Zod.z.ZodSet<Value>, "many">
Returns Zod.z.ZodArray<Zod.z.ZodSet<Value>, "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.ZodSet<Value>, B>
Type Parameters
- B extends string | number | symbol
Parameters
- Optionalbrand: B
Returns Zod.z.ZodBranded<Zod.z.ZodSet<Value>, B>
Inherited from ZodType.brand
- Defined in node_modules/zod/lib/types.d.ts:84

catch

catch(def: Set<Value["_output"]>): Zod.z.ZodCatch<Zod.z.ZodSet<Value>>
Parameters
- def: Set<Value["_output"]>
Returns Zod.z.ZodCatch<Zod.z.ZodSet<Value>>
Inherited from ZodType.catch
- Defined in node_modules/zod/lib/types.d.ts:85
catch(
    def: (
        ctx: { error: Zod.z.ZodError<any>; input: Set<Value["_input"]> },
    ) => Set<Value["_output"]>,
): Zod.z.ZodCatch<Zod.z.ZodSet<Value>>
Parameters
- def: (
  ctx: { error: Zod.z.ZodError<any>; input: Set<Value["_input"]> },
  ) => Set<Value["_output"]>
Returns Zod.z.ZodCatch<Zod.z.ZodSet<Value>>
Inherited from ZodType.catch
- Defined in node_modules/zod/lib/types.d.ts:86

default

default(def: Set<Value["_input"]>): Zod.z.ZodDefault<Zod.z.ZodSet<Value>>
Parameters
- def: Set<Value["_input"]>
Returns Zod.z.ZodDefault<Zod.z.ZodSet<Value>>
Inherited from ZodType.default
- Defined in node_modules/zod/lib/types.d.ts:82
default(def: () => Set<Value["_input"]>): Zod.z.ZodDefault<Zod.z.ZodSet<Value>>
Parameters
- def: () => Set<Value["_input"]>
Returns Zod.z.ZodDefault<Zod.z.ZodSet<Value>>
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

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

max

max(maxSize: number, message?: ErrMessage): this
Parameters
- maxSize: number
- Optionalmessage: ErrMessage
Returns this
- Defined in node_modules/zod/lib/types.d.ts:671

min

min(minSize: number, message?: ErrMessage): this
Parameters
- minSize: number
- Optionalmessage: ErrMessage
Returns this
- Defined in node_modules/zod/lib/types.d.ts:670

nonempty

nonempty(message?: ErrMessage): Zod.z.ZodSet<Value>
Parameters
- Optionalmessage: ErrMessage
Returns Zod.z.ZodSet<Value>
- Defined in node_modules/zod/lib/types.d.ts:673

nullable

nullable(): Zod.z.ZodNullable<Zod.z.ZodSet<Value>>
Returns Zod.z.ZodNullable<Zod.z.ZodSet<Value>>
Inherited from ZodType.nullable
- Defined in node_modules/zod/lib/types.d.ts:75

nullish

nullish(): Zod.z.ZodOptional<Zod.z.ZodNullable<Zod.z.ZodSet<Value>>>
Returns Zod.z.ZodOptional<Zod.z.ZodNullable<Zod.z.ZodSet<Value>>>
Inherited from ZodType.nullish
- Defined in node_modules/zod/lib/types.d.ts:76

optional

optional(): Zod.z.ZodOptional<Zod.z.ZodSet<Value>>
Returns Zod.z.ZodOptional<Zod.z.ZodSet<Value>>
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.ZodSet<Value>, T]>
Type Parameters
- T extends Zod.z.ZodTypeAny
Parameters
- option: T
Returns Zod.z.ZodUnion<[Zod.z.ZodSet<Value>, T]>
Inherited from ZodType.or
- Defined in node_modules/zod/lib/types.d.ts:79

parse

parse(data: unknown, params?: Partial<Zod.z.ParseParams>): Set<Value["_output"]>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.z.ParseParams>
Returns Set<Value["_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<Set<Value["_output"]>>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.z.ParseParams>
Returns Promise<Set<Value["_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.ZodSet<Value>, T>
Type Parameters
- T extends Zod.z.ZodTypeAny
Parameters
- target: T
Returns Zod.z.ZodPipeline<Zod.z.ZodSet<Value>, T>
Inherited from ZodType.pipe
- Defined in node_modules/zod/lib/types.d.ts:91

promise

promise(): Zod.z.ZodPromise<Zod.z.ZodSet<Value>>
Returns Zod.z.ZodPromise<Zod.z.ZodSet<Value>>
Inherited from ZodType.promise
- Defined in node_modules/zod/lib/types.d.ts:78

readonly

readonly(): Zod.z.ZodReadonly<Zod.z.ZodSet<Value>>
Returns Zod.z.ZodReadonly<Zod.z.ZodSet<Value>>
Inherited from ZodType.readonly
- Defined in node_modules/zod/lib/types.d.ts:92

refine

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

refinement

refinement<RefinedOutput extends Set<Value["_output"]>>(
    check: (arg: Set<Value["_output"]>) => arg is RefinedOutput,
    refinementData:
        | Zod.z.IssueData
        | (
            arg: Set<Value["_output"]>,
            ctx: Zod.z.RefinementCtx,
        ) => Zod.z.IssueData,
): Zod.z.ZodEffects<
    Zod.z.ZodSet<Value>,
    RefinedOutput,
    Set<Value["_input"]>,
>
Type Parameters
- RefinedOutput extends Set<Value["_output"]>
Parameters
- check: (arg: Set<Value["_output"]>) => arg is RefinedOutput
- refinementData:
  | Zod.z.IssueData
  | (arg: Set<Value["_output"]>, ctx: Zod.z.RefinementCtx) => Zod.z.IssueData
Returns Zod.z.ZodEffects<Zod.z.ZodSet<Value>, RefinedOutput, Set<Value["_input"]>>
Inherited from ZodType.refinement
- Defined in node_modules/zod/lib/types.d.ts:67
refinement(
    check: (arg: Set<Value["_output"]>) => boolean,
    refinementData:
        | Zod.z.IssueData
        | (
            arg: Set<Value["_output"]>,
            ctx: Zod.z.RefinementCtx,
        ) => Zod.z.IssueData,
): Zod.z.ZodEffects<
    Zod.z.ZodSet<Value>,
    Set<Value["_output"]>,
    Set<Value["_input"]>,
>
Parameters
- check: (arg: Set<Value["_output"]>) => boolean
- refinementData:
  | Zod.z.IssueData
  | (arg: Set<Value["_output"]>, ctx: Zod.z.RefinementCtx) => Zod.z.IssueData
Returns Zod.z.ZodEffects<
    Zod.z.ZodSet<Value>,
    Set<Value["_output"]>,
    Set<Value["_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<Set<Value["_input"]>, Set<Value["_output"]>>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.z.ParseParams>
Returns Zod.z.SafeParseReturnType<Set<Value["_input"]>, Set<Value["_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<Set<Value["_input"]>, Set<Value["_output"]>>,
>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.z.ParseParams>
Returns Promise<Zod.z.SafeParseReturnType<Set<Value["_input"]>, Set<Value["_output"]>>>
Inherited from ZodType.safeParseAsync
- Defined in node_modules/zod/lib/types.d.ts:62

size

size(size: number, message?: ErrMessage): this
Parameters
- size: number
- Optionalmessage: ErrMessage
Returns this
- Defined in node_modules/zod/lib/types.d.ts:672

superRefine

superRefine<RefinedOutput extends Set<Value["_output"]>>(
    refinement: (
        arg: Set<Value["_output"]>,
        ctx: Zod.z.RefinementCtx,
    ) => arg is RefinedOutput,
): Zod.z.ZodEffects<
    Zod.z.ZodSet<Value>,
    RefinedOutput,
    Set<Value["_input"]>,
>
Type Parameters
- RefinedOutput extends Set<Value["_output"]>
Parameters
- refinement: (arg: Set<Value["_output"]>, ctx: Zod.z.RefinementCtx) => arg is RefinedOutput
Returns Zod.z.ZodEffects<Zod.z.ZodSet<Value>, RefinedOutput, Set<Value["_input"]>>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/lib/types.d.ts:70
superRefine(
    refinement: (
        arg: Set<Value["_output"]>,
        ctx: Zod.z.RefinementCtx,
    ) => void,
): Zod.z.ZodEffects<
    Zod.z.ZodSet<Value>,
    Set<Value["_output"]>,
    Set<Value["_input"]>,
>
Parameters
- refinement: (arg: Set<Value["_output"]>, ctx: Zod.z.RefinementCtx) => void
Returns Zod.z.ZodEffects<
    Zod.z.ZodSet<Value>,
    Set<Value["_output"]>,
    Set<Value["_input"]>,
>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/lib/types.d.ts:71
superRefine(
    refinement: (
        arg: Set<Value["_output"]>,
        ctx: Zod.z.RefinementCtx,
    ) => Promise<void>,
): Zod.z.ZodEffects<
    Zod.z.ZodSet<Value>,
    Set<Value["_output"]>,
    Set<Value["_input"]>,
>
Parameters
- refinement: (arg: Set<Value["_output"]>, ctx: Zod.z.RefinementCtx) => Promise<void>
Returns Zod.z.ZodEffects<
    Zod.z.ZodSet<Value>,
    Set<Value["_output"]>,
    Set<Value["_input"]>,
>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/lib/types.d.ts:72

transform

transform<NewOut>(
    transform: (
        arg: Set<Value["_output"]>,
        ctx: Zod.z.RefinementCtx,
    ) => NewOut | Promise<NewOut>,
): Zod.z.ZodEffects<Zod.z.ZodSet<Value>, NewOut, Set<Value["_input"]>>
Type Parameters
- NewOut
Parameters
- transform: (
  arg: Set<Value["_output"]>,
  ctx: Zod.z.RefinementCtx,
  ) => NewOut | Promise<NewOut>
Returns Zod.z.ZodEffects<Zod.z.ZodSet<Value>, NewOut, Set<Value["_input"]>>
Inherited from ZodType.transform
- Defined in node_modules/zod/lib/types.d.ts:81

Class ZodSet<Value>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Zod.z.ZodSet<Value>

Properties

Readonly_def

Readonly_input

Readonly_output

Readonly_type

spa

Staticcreate

Accessors

description

Returns undefined | string

Methods

_getOrReturnCtx

Parameters

Returns Zod.z.ParseContext

_getType

Parameters

Returns string

_parse

Parameters

Returns Zod.z.ParseReturnType<Set<Value["_output"]>>

_parseAsync

Parameters

Returns Zod.z.AsyncParseReturnType<Set<Value["_output"]>>

_parseSync

Parameters

Returns Zod.z.SyncParseReturnType<Set<Value["_output"]>>

_processInputParams

Parameters

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

_refinement

Parameters

Returns Zod.z.ZodEffects< Zod.z.ZodSet<Value>, Set<Value["_output"]>, Set<Value["_input"]>,>

and

Type Parameters

Parameters

Returns Zod.z.ZodIntersection<Zod.z.ZodSet<Value>, T>

array

Returns Zod.z.ZodArray<Zod.z.ZodSet<Value>, "many">

brand

Type Parameters

Parameters

Returns Zod.z.ZodBranded<Zod.z.ZodSet<Value>, B>

catch

Parameters

Returns Zod.z.ZodCatch<Zod.z.ZodSet<Value>>

Parameters

Returns Zod.z.ZodCatch<Zod.z.ZodSet<Value>>

default

Parameters

Returns Zod.z.ZodDefault<Zod.z.ZodSet<Value>>

Parameters

Returns Zod.z.ZodDefault<Zod.z.ZodSet<Value>>

describe

Parameters

Returns this

isNullable

Returns boolean

isOptional

Returns boolean

max

Parameters

Returns this

min

Parameters

Returns this

nonempty

Parameters

`Readonly`_def

`Readonly`_input

`Readonly`_output

`Readonly`_type

`Static`create

Returns Zod.z.ZodEffects<
Zod.z.ZodSet<Value>,
Set<Value["_output"]>,
Set<Value["_input"]>,
>

Returns Zod.z.ZodEffects<
Zod.z.ZodSet<Value>,
Set<Value["_output"]>,
Set<Value["_input"]>,
>

Returns Zod.z.ZodEffects<
Zod.z.ZodSet<Value>,
Set<Value["_output"]>,
Set<Value["_input"]>,
>

Returns Zod.z.ZodEffects<
Zod.z.ZodSet<Value>,
Set<Value["_output"]>,
Set<Value["_input"]>,
>

Returns Zod.z.ZodEffects<
Zod.z.ZodSet<Value>,
Set<Value["_output"]>,
Set<Value["_input"]>,
>