Class ZodEnum<T>

Type Parameters

T extends [string, ...string[]]

Hierarchy (View Summary)

Zod.ZodType<T[number], Zod.ZodEnumDef<T>>
- ZodEnum

Index

Constructors

constructor

new ZodEnum<T extends [string, ...string[]]>(
def: Zod.ZodEnumDef,
): Zod.ZodEnum<T>
Type Parameters
- T extends [string, ...string[]]
Parameters
- def: Zod.ZodEnumDef
Returns Zod.ZodEnum<T>
Inherited from ZodType.constructor

Properties

`Readonly`_def

_def: Zod.ZodEnumDef

`Readonly`_input

_input: T[number]

`Readonly`_output

_output: T[number]

`Readonly`_type

_type: T[number]

spa

spa: (
data: unknown,
params?: Partial<Zod.ParseParams>,
) => Promise<Zod.SafeParseReturnType<T[number], T[number]>>

Alias of safeParseAsync

`Static`create

create: {
    <U extends string, T extends readonly [U, U]>(
        values: T,
        params?: Zod.RawCreateParams,
    ): Zod.ZodEnum<Zod.Writeable<T>>;
    <U extends string, T extends [U, ...U[]]>(
        values: T,
        params?: Zod.RawCreateParams,
    ): Zod.ZodEnum<T>;
}

Accessors

description

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

enum

get enum(): Zod.Values<T>
Returns Zod.Values<T>

Enum

get Enum(): Zod.Values<T>
Returns Zod.Values<T>

options

get options(): T
Returns T

Values

get Values(): Zod.Values<T>
Returns Zod.Values<T>

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

_parse

_parse(input: Zod.ParseInput): Zod.ParseReturnType<T[number]>
Parameters
- input: Zod.ParseInput
Returns Zod.ParseReturnType<T[number]>
Overrides ZodType._parse

_parseAsync

_parseAsync(input: Zod.ParseInput): Zod.AsyncParseReturnType<T[number]>
Parameters
- input: Zod.ParseInput
Returns Zod.AsyncParseReturnType<T[number]>
Inherited from ZodType._parseAsync

_parseSync

_parseSync(input: Zod.ParseInput): Zod.SyncParseReturnType<T[number]>
Parameters
- input: Zod.ParseInput
Returns Zod.SyncParseReturnType<T[number]>
Inherited from ZodType._parseSync

_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: T[number], ctx: Zod.RefinementCtx) => any,
): Zod.ZodEffects<Zod.ZodEnum<T>, T[number], T[number]>
Parameters
- refinement: (arg: T[number], ctx: Zod.RefinementCtx) => any
Returns Zod.ZodEffects<Zod.ZodEnum<T>, T[number], T[number]>
Inherited from ZodType._refinement

and

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

array

array(): Zod.ZodArray<Zod.ZodEnum<T>>
Returns Zod.ZodArray<Zod.ZodEnum<T>>
Inherited from ZodType.array

brand

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

catch

catch(def: T[number]): Zod.ZodCatch<Zod.ZodEnum<T>>
Parameters
- def: T[number]
Returns Zod.ZodCatch<Zod.ZodEnum<T>>
Inherited from ZodType.catch
catch(
def: (ctx: { error: Zod.ZodError; input: T[number] }) => T[number],
): Zod.ZodCatch<Zod.ZodEnum<T>>
Parameters
- def: (ctx: { error: Zod.ZodError; input: T[number] }) => T[number]
Returns Zod.ZodCatch<Zod.ZodEnum<T>>
Inherited from ZodType.catch

default

default(def: noUndefined<T[number]>): Zod.ZodDefault<Zod.ZodEnum<T>>
Parameters
- def: noUndefined<T[number]>
Returns Zod.ZodDefault<Zod.ZodEnum<T>>
Inherited from ZodType.default
default(def: () => noUndefined<T[number]>): Zod.ZodDefault<Zod.ZodEnum<T>>
Parameters
- def: () => noUndefined<T[number]>
Returns Zod.ZodDefault<Zod.ZodEnum<T>>
Inherited from ZodType.default

describe

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

exclude

exclude<ToExclude extends readonly [T[number], T[number]]>(
    values: ToExclude,
): Zod.ZodEnum<
    Zod.typecast<
        Zod.Writeable<Zod.FilterEnum<T, ToExclude[number]>>,
        [string, ...string[]],
    >,
>
Type Parameters
- ToExclude extends readonly [T[number], T[number]]
Parameters
- values: ToExclude
Returns Zod.ZodEnum<
    Zod.typecast<
        Zod.Writeable<Zod.FilterEnum<T, ToExclude[number]>>,
        [string, ...string[]],
    >,
>

extract

extract<ToExtract extends readonly [T[number], T[number]]>(
values: ToExtract,
): Zod.ZodEnum<Zod.Writeable<ToExtract>>
Type Parameters
- ToExtract extends readonly [T[number], T[number]]
Parameters
- values: ToExtract
Returns Zod.ZodEnum<Zod.Writeable<ToExtract>>

isNullable

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

isOptional

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

nullable

nullable(): Zod.ZodNullable<Zod.ZodEnum<T>>
Returns Zod.ZodNullable<Zod.ZodEnum<T>>
Inherited from ZodType.nullable

nullish

nullish(): Zod.ZodOptional<Zod.ZodNullable<Zod.ZodEnum<T>>>
Returns Zod.ZodOptional<Zod.ZodNullable<Zod.ZodEnum<T>>>
Inherited from ZodType.nullish

optional

optional(): Zod.ZodOptional<Zod.ZodEnum<T>>
Returns Zod.ZodOptional<Zod.ZodEnum<T>>
Inherited from ZodType.optional

or

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

parse

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

parseAsync

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

pipe

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

promise

promise(): Zod.ZodPromise<Zod.ZodEnum<T>>
Returns Zod.ZodPromise<Zod.ZodEnum<T>>
Inherited from ZodType.promise

readonly

readonly(): Zod.ZodReadonly<Zod.ZodEnum<T>>
Returns Zod.ZodReadonly<Zod.ZodEnum<T>>
Inherited from ZodType.readonly

refine

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

refinement<RefinedOutput extends string>(
    check: (arg: T[number]) => arg is RefinedOutput,
    refinementData:
        | Zod.IssueData
        | ((arg: T[number], ctx: Zod.RefinementCtx) => Zod.IssueData),
): Zod.ZodEffects<Zod.ZodEnum<T>, RefinedOutput, T[number]>
Type Parameters
- RefinedOutput extends string
Parameters
- check: (arg: T[number]) => arg is RefinedOutput
- refinementData: Zod.IssueData | ((arg: T[number], ctx: Zod.RefinementCtx) => Zod.IssueData)
Returns Zod.ZodEffects<Zod.ZodEnum<T>, RefinedOutput, T[number]>
Inherited from ZodType.refinement
refinement(
    check: (arg: T[number]) => boolean,
    refinementData:
        | Zod.IssueData
        | ((arg: T[number], ctx: Zod.RefinementCtx) => Zod.IssueData),
): Zod.ZodEffects<Zod.ZodEnum<T>, T[number], T[number]>
Parameters
- check: (arg: T[number]) => boolean
- refinementData: Zod.IssueData | ((arg: T[number], ctx: Zod.RefinementCtx) => Zod.IssueData)
Returns Zod.ZodEffects<Zod.ZodEnum<T>, T[number], T[number]>
Inherited from ZodType.refinement

safeParse

safeParse(
data: unknown,
params?: Partial<Zod.ParseParams>,
): Zod.SafeParseReturnType<T[number], T[number]>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.ParseParams>
Returns Zod.SafeParseReturnType<T[number], T[number]>
Inherited from ZodType.safeParse

safeParseAsync

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

superRefine

superRefine<RefinedOutput extends string>(
    refinement: (
        arg: T[number],
        ctx: Zod.RefinementCtx,
    ) => arg is RefinedOutput,
): Zod.ZodEffects<Zod.ZodEnum<T>, RefinedOutput, T[number]>
Type Parameters
- RefinedOutput extends string
Parameters
- refinement: (arg: T[number], ctx: Zod.RefinementCtx) => arg is RefinedOutput
Returns Zod.ZodEffects<Zod.ZodEnum<T>, RefinedOutput, T[number]>
Inherited from ZodType.superRefine
superRefine(
refinement: (arg: T[number], ctx: Zod.RefinementCtx) => void,
): Zod.ZodEffects<Zod.ZodEnum<T>, T[number], T[number]>
Parameters
- refinement: (arg: T[number], ctx: Zod.RefinementCtx) => void
Returns Zod.ZodEffects<Zod.ZodEnum<T>, T[number], T[number]>
Inherited from ZodType.superRefine
superRefine(
refinement: (arg: T[number], ctx: Zod.RefinementCtx) => Promise<void>,
): Zod.ZodEffects<Zod.ZodEnum<T>, T[number], T[number]>
Parameters
- refinement: (arg: T[number], ctx: Zod.RefinementCtx) => Promise<void>
Returns Zod.ZodEffects<Zod.ZodEnum<T>, T[number], T[number]>
Inherited from ZodType.superRefine

transform

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

Class ZodEnum<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Zod.ZodEnum<T>

Properties

Readonly_def

Readonly_input

Readonly_output

Readonly_type

spa

Staticcreate

Accessors

description

Returns undefined | string

enum

Returns Zod.Values<T>

Enum

Returns Zod.Values<T>

options

Returns T

Values

Returns Zod.Values<T>

Methods

_getOrReturnCtx

Parameters

Returns Zod.ParseContext

_getType

Parameters

Returns string

_parse

Parameters

Returns Zod.ParseReturnType<T[number]>

_parseAsync

Parameters

Returns Zod.AsyncParseReturnType<T[number]>

_parseSync

Parameters

Returns Zod.SyncParseReturnType<T[number]>

_processInputParams

Parameters

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

_refinement

Parameters

Returns Zod.ZodEffects<Zod.ZodEnum<T>, T[number], T[number]>

and

Type Parameters

Parameters

Returns Zod.ZodIntersection<Zod.ZodEnum<T>, T>

array

Returns Zod.ZodArray<Zod.ZodEnum<T>>

brand

Type Parameters

Parameters

Returns Zod.ZodBranded<Zod.ZodEnum<T>, B>

catch

Parameters

Returns Zod.ZodCatch<Zod.ZodEnum<T>>

Parameters

Returns Zod.ZodCatch<Zod.ZodEnum<T>>

default

Parameters

Returns Zod.ZodDefault<Zod.ZodEnum<T>>

Parameters

Returns Zod.ZodDefault<Zod.ZodEnum<T>>

describe

Parameters

Returns this

exclude

Type Parameters

Parameters

Returns Zod.ZodEnum< Zod.typecast< Zod.Writeable<Zod.FilterEnum<T, ToExclude[number]>>, [string, ...string[]], >,>

`Readonly`_def

`Readonly`_input

`Readonly`_output

`Readonly`_type

`Static`create

Returns Zod.ZodEnum<
Zod.typecast<
Zod.Writeable<Zod.FilterEnum<T, ToExclude[number]>>,
[string, ...string[]],
>,
>