Class ZodEnum<T>

Type Parameters

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

Hierarchy (View Summary)

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

Index

Constructors

constructor

new ZodEnum<T extends [string, ...string[]]>(
def: Zod.z.ZodEnumDef<T>,
): Zod.z.ZodEnum<T>
Type Parameters
- T extends [string, ...string[]]
Parameters
- def: Zod.z.ZodEnumDef<T>
Returns Zod.z.ZodEnum<T>
Inherited from ZodType.constructor
- Defined in node_modules/zod/lib/types.d.ts:73

Properties

`Readonly`_def

_def: Zod.z.ZodEnumDef<T>

`Readonly`_input

_input: T[number]

`Readonly`_output

_output: T[number]

`Readonly`_type

_type: T[number]

spa

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

Alias of safeParseAsync

`Static`create

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

Accessors

description

get description(): undefined | string
Returns undefined | string
Inherited from ZodType.description
- Defined in node_modules/zod/lib/types.d.ts:49

enum

get enum(): Zod.z.Values<T>
Returns Zod.z.Values<T>
- Defined in node_modules/zod/lib/types.d.ts:735

Enum

get Enum(): Zod.z.Values<T>
Returns Zod.z.Values<T>
- Defined in node_modules/zod/lib/types.d.ts:737

options

get options(): T
Returns T
- Defined in node_modules/zod/lib/types.d.ts:734

Values

get Values(): Zod.z.Values<T>
Returns Zod.z.Values<T>
- Defined in node_modules/zod/lib/types.d.ts:736

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<T[number]>
Parameters
- input: Zod.z.ParseInput
Returns Zod.z.ParseReturnType<T[number]>
Overrides ZodType._parse
- Defined in node_modules/zod/lib/types.d.ts:733

_parseAsync

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

_parseSync

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

array

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

catch

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

default

default(def: noUndefined<T[number]>): Zod.z.ZodDefault<Zod.z.ZodEnum<T>>
Parameters
- def: noUndefined<T[number]>
Returns Zod.z.ZodDefault<Zod.z.ZodEnum<T>>
Inherited from ZodType.default
- Defined in node_modules/zod/lib/types.d.ts:82
default(def: () => noUndefined<T[number]>): Zod.z.ZodDefault<Zod.z.ZodEnum<T>>
Parameters
- def: () => noUndefined<T[number]>
Returns Zod.z.ZodDefault<Zod.z.ZodEnum<T>>
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

exclude

exclude<ToExclude extends readonly [T[number], T[number]]>(
    values: ToExclude,
): Zod.z.ZodEnum<
    Zod.z.typecast<
        Zod.z.Writeable<Zod.z.FilterEnum<T, ToExclude[number]>>,
        [string, ...string[]],
    >,
>
Type Parameters
- ToExclude extends readonly [T[number], T[number]]
Parameters
- values: ToExclude
Returns Zod.z.ZodEnum<
    Zod.z.typecast<
        Zod.z.Writeable<Zod.z.FilterEnum<T, ToExclude[number]>>,
        [string, ...string[]],
    >,
>
- Defined in node_modules/zod/lib/types.d.ts:739

extract

extract<ToExtract extends readonly [T[number], T[number]]>(
values: ToExtract,
): Zod.z.ZodEnum<Zod.z.Writeable<ToExtract>>
Type Parameters
- ToExtract extends readonly [T[number], T[number]]
Parameters
- values: ToExtract
Returns Zod.z.ZodEnum<Zod.z.Writeable<ToExtract>>
- Defined in node_modules/zod/lib/types.d.ts:738

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

nullable

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

nullish

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

optional

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

parse

parse(data: unknown, params?: Partial<Zod.z.ParseParams>): T[number]
Parameters
- data: unknown
- Optionalparams: Partial<Zod.z.ParseParams>
Returns T[number]
Inherited from ZodType.parse
- Defined in node_modules/zod/lib/types.d.ts:59

parseAsync

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

promise

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

readonly

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

refine

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

refinement

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

superRefine

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

transform

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

Class ZodEnum<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Zod.z.ZodEnum<T>

Properties

Readonly_def

Readonly_input

Readonly_output

Readonly_type

spa

Staticcreate

Accessors

description

Returns undefined | string

enum

Returns Zod.z.Values<T>

Enum

Returns Zod.z.Values<T>

options

Returns T

Values

Returns Zod.z.Values<T>

Methods

_getOrReturnCtx

Parameters

Returns Zod.z.ParseContext

_getType

Parameters

Returns string

_parse

Parameters

Returns Zod.z.ParseReturnType<T[number]>

_parseAsync

Parameters

Returns Zod.z.AsyncParseReturnType<T[number]>

_parseSync

Parameters

Returns Zod.z.SyncParseReturnType<T[number]>

_processInputParams

Parameters

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

_refinement

Parameters

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

and

Type Parameters

Parameters

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

array

Returns Zod.z.ZodArray<Zod.z.ZodEnum<T>, "many">

brand

Type Parameters

Parameters

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

catch

Parameters

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

Parameters

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

default

Parameters

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

Parameters

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

describe

Parameters

Returns this

exclude

Type Parameters

Parameters

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

`Readonly`_def

`Readonly`_input

`Readonly`_output

`Readonly`_type

`Static`create

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