Class ZodSet<Value>

Type Parameters

Value extends ZodTypeAny = ZodTypeAny

Hierarchy (View Summary)

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

Index

Constructors

constructor

new ZodSet<Value extends ZodTypeAny = ZodTypeAny>(def: ZodSetDef): ZodSet<Value>
Type Parameters
- Value extends ZodTypeAny = ZodTypeAny
Parameters
- def: ZodSetDef
Returns ZodSet<Value>
Inherited from ZodType.constructor
- Defined in node_modules/zod/v3/types.d.cts:79

Properties

`Readonly`_type

_type: Set

`Readonly`_output

_output: Set

`Readonly`_input

_input: Set

`Readonly`_def

_def: ZodSetDef

~standard

"~standard": Props<Set<Value["_input"]>, Set<Value["_output"]>>

spa

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

Alias of safeParseAsync

`Static`create

create: <ValueSchema extends ZodTypeAny = ZodTypeAny>(
valueType: ValueSchema,
params?: RawCreateParams,
) => ZodSet<ValueSchema>

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

_parseAsync

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

parse

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

safeParse

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

~validate

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

parseAsync

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

safeParseAsync

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

refine

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

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

_refinement

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

superRefine

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

optional

optional(): ZodOptional<ZodSet<Value>>
Returns ZodOptional<ZodSet<Value>>
Inherited from ZodType.optional
- Defined in node_modules/zod/v3/types.d.cts:80

nullable

nullable(): ZodNullable<ZodSet<Value>>
Returns ZodNullable<ZodSet<Value>>
Inherited from ZodType.nullable
- Defined in node_modules/zod/v3/types.d.cts:81

nullish

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

array

array(): ZodArray<ZodSet<Value>>
Returns ZodArray<ZodSet<Value>>
Inherited from ZodType.array
- Defined in node_modules/zod/v3/types.d.cts:83

promise

promise(): ZodPromise<ZodSet<Value>>
Returns ZodPromise<ZodSet<Value>>
Inherited from ZodType.promise
- Defined in node_modules/zod/v3/types.d.cts:84

or

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

and

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

transform

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

default

default(def: Set<Value["_input"]>): ZodDefault<ZodSet<Value>>
Parameters
- def: Set<Value["_input"]>
Returns ZodDefault<ZodSet<Value>>
Inherited from ZodType.default
- Defined in node_modules/zod/v3/types.d.cts:88
default(def: () => Set<Value["_input"]>): ZodDefault<ZodSet<Value>>
Parameters
- def: () => Set<Value["_input"]>
Returns ZodDefault<ZodSet<Value>>
Inherited from ZodType.default
- Defined in node_modules/zod/v3/types.d.cts:89

brand

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

catch

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

readonly

readonly(): ZodReadonly<ZodSet<Value>>
Returns ZodReadonly<ZodSet<Value>>
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<Set<Value["_output"]>>
Parameters
- input: ParseInput
Returns ParseReturnType<Set<Value["_output"]>>
Overrides ZodType._parse
- Defined in node_modules/zod/v3/types.d.cts:699

min

min(minSize: number, message?: ErrMessage): this
Parameters
- minSize: number
- Optionalmessage: ErrMessage
Returns this
- Defined in node_modules/zod/v3/types.d.cts:700

max

max(maxSize: number, message?: ErrMessage): this
Parameters
- maxSize: number
- Optionalmessage: ErrMessage
Returns this
- Defined in node_modules/zod/v3/types.d.cts:701

size

size(size: number, message?: ErrMessage): this
Parameters
- size: number
- Optionalmessage: ErrMessage
Returns this
- Defined in node_modules/zod/v3/types.d.cts:702

nonempty

nonempty(message?: ErrMessage): ZodSet<Value>
Parameters
- Optionalmessage: ErrMessage
Returns ZodSet<Value>
- Defined in node_modules/zod/v3/types.d.cts:703

Class ZodSet<Value>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ZodSet<Value>

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<Set<Value["_output"]>>

_parseAsync

Parameters

Returns AsyncParseReturnType<Set<Value["_output"]>>

parse

Parameters

Returns Set

safeParse

Parameters

Returns SafeParseReturnType<Set<Value["_input"]>, Set<Value["_output"]>>

~validate

Parameters

Returns Result<Set<Value["_output"]>> | Promise<Result<Set<Value["_output"]>>>

parseAsync

Parameters

Returns Promise<Set<Value["_output"]>>

safeParseAsync

Parameters

Returns Promise<SafeParseReturnType<Set<Value["_input"]>, Set<Value["_output"]>>>

refine

Type Parameters

Parameters

Returns ZodEffects<ZodSet<Value>, RefinedOutput, Set<Value["_input"]>>

Parameters

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

refinement

Type Parameters

Parameters

Returns ZodEffects<ZodSet<Value>, RefinedOutput, Set<Value["_input"]>>

Parameters

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

_refinement

Parameters

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

superRefine

Type Parameters

Parameters

Returns ZodEffects<ZodSet<Value>, RefinedOutput, Set<Value["_input"]>>

Parameters

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

Parameters

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

optional

Returns ZodOptional<ZodSet<Value>>

`Readonly`_type

`Readonly`_output

`Readonly`_input

`Readonly`_def

`Static`create