Class ZodEnum<T>

Type Parameters

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

Hierarchy (View Summary)

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

Index

Constructors

constructor

new ZodEnum<T extends [string, ...string[]]>(def: ZodEnumDef): ZodEnum<T>
Type Parameters
- T extends [string, ...string[]]
Parameters
- def: ZodEnumDef
Returns ZodEnum<T>
Inherited from ZodType.constructor
- Defined in ../../node_modules/zod/v3/types.d.cts:79

Properties

`Readonly`_type

_type: T[number]

`Readonly`_output

_output: T[number]

`Readonly`_input

_input: T[number]

`Readonly`_def

_def: ZodEnumDef

~standard

"~standard": Props<T[number], T[number]>

spa

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

Alias of safeParseAsync

_cache

_cache: undefined | Set<T[number]>

`Static`create

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

Accessors

description

get description(): undefined | string
Returns undefined | string
Inherited from ZodType.description
- Defined in ../../node_modules/zod/v3/types.d.cts:53

options

get options(): T
Returns T
- Defined in ../../node_modules/zod/v3/types.d.cts:765

enum

get enum(): Values<T>
Returns Values<T>
- Defined in ../../node_modules/zod/v3/types.d.cts:766

Values

get Values(): Values<T>
Returns Values<T>
- Defined in ../../node_modules/zod/v3/types.d.cts:767

Enum

get Enum(): Values<T>
Returns Values<T>
- Defined in ../../node_modules/zod/v3/types.d.cts:768

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

_parseAsync

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

parse

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

safeParse

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

~validate

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

parseAsync

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

safeParseAsync

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

refine

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

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

_refinement

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

superRefine

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

optional

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

nullable

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

nullish

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

array

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

promise

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

or

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

and

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

transform

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

default

default(def: noUndefined<T[number]>): ZodDefault<ZodEnum<T>>
Parameters
- def: noUndefined<T[number]>
Returns ZodDefault<ZodEnum<T>>
Inherited from ZodType.default
- Defined in ../../node_modules/zod/v3/types.d.cts:88
default(def: () => noUndefined<T[number]>): ZodDefault<ZodEnum<T>>
Parameters
- def: () => noUndefined<T[number]>
Returns ZodDefault<ZodEnum<T>>
Inherited from ZodType.default
- Defined in ../../node_modules/zod/v3/types.d.cts:89

brand

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

catch

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

readonly

readonly(): ZodReadonly<ZodEnum<T>>
Returns ZodReadonly<ZodEnum<T>>
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[number]>
Parameters
- input: ParseInput
Returns ParseReturnType<T[number]>
Overrides ZodType._parse
- Defined in ../../node_modules/zod/v3/types.d.cts:764

extract

extract<ToExtract extends readonly [T[number], T[number]]>(
values: ToExtract,
newDef?: RawCreateParams,
): ZodEnum<Writeable<ToExtract>>
Type Parameters
- ToExtract extends readonly [T[number], T[number]]
Parameters
- values: ToExtract
- OptionalnewDef: RawCreateParams
Returns ZodEnum<Writeable<ToExtract>>
- Defined in ../../node_modules/zod/v3/types.d.cts:769

exclude

exclude<ToExclude extends readonly [T[number], T[number]]>(
    values: ToExclude,
    newDef?: RawCreateParams,
): ZodEnum<
    typecast<
        Writeable<FilterEnum<T, ToExclude[number]>>,
        [string, ...string[]],
    >,
>
Type Parameters
- ToExclude extends readonly [T[number], T[number]]
Parameters
- values: ToExclude
- OptionalnewDef: RawCreateParams
Returns ZodEnum<
    typecast<
        Writeable<FilterEnum<T, ToExclude[number]>>,
        [string, ...string[]],
    >,
>
- Defined in ../../node_modules/zod/v3/types.d.cts:770

Class ZodEnum<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ZodEnum<T>

Properties

Readonly_type

Readonly_output

Readonly_input

Readonly_def

~standard

spa

_cache

Staticcreate

Accessors

description

Returns undefined | string

options

Returns T

enum

Returns Values<T>

Values

Returns Values<T>

Enum

Returns Values<T>

Methods

_getType

Parameters

Returns string

_getOrReturnCtx

Parameters

Returns ParseContext

_processInputParams

Parameters

Returns { status: ParseStatus; ctx: ParseContext }

_parseSync

Parameters

Returns SyncParseReturnType<T[number]>

_parseAsync

Parameters

Returns AsyncParseReturnType<T[number]>

parse

Parameters

Returns T[number]

safeParse

Parameters

Returns SafeParseReturnType<T[number], T[number]>

~validate

Parameters

Returns Result<T[number]> | Promise<Result<T[number]>>

parseAsync

Parameters

Returns Promise<T[number]>

safeParseAsync

Parameters

Returns Promise<SafeParseReturnType<T[number], T[number]>>

refine

Type Parameters

Parameters

Returns ZodEffects<ZodEnum<T>, RefinedOutput, T[number]>

Parameters

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

refinement

Type Parameters

Parameters

Returns ZodEffects<ZodEnum<T>, RefinedOutput, T[number]>

Parameters

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

_refinement

Parameters

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

superRefine

`Readonly`_type

`Readonly`_output

`Readonly`_input

`Readonly`_def

`Static`create

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