Class ZodEnum<T>

Type Parameters

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

Hierarchy (view full)

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

Index

Constructors

constructor

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

Properties

`Readonly`_def

_def: ZodEnumDef<T>

`Readonly`_input

_input: T[number]

`Readonly`_output

_output: T[number]

`Readonly`_type

_type: T[number]

spa

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

Alias of safeParseAsync

`Static`create

create: {
<U, T>(values: T, params?: RawCreateParams): ZodEnum<Writeable<T>>;
<U, T>(values: T, params?: RawCreateParams): ZodEnum<T>;
}

Accessors

Enum

get Enum(): Values<T>
Returns Values<T>
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:782

Values

get Values(): Values<T>
Returns Values<T>
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:781

description

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

enum

get enum(): Values<T>
Returns Values<T>
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:780

options

get options(): T
Returns T
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:779

Methods

_getOrReturnCtx

_getOrReturnCtx(input, ctx?): ParseContext
Parameters
- input: ParseInput
- Optionalctx: ParseContext
Returns ParseContext
Inherited from ZodType._getOrReturnCtx
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:55

_getType

_getType(input): string
Parameters
- input: ParseInput
Returns string
Inherited from ZodType._getType
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:54

_parse

_parse(input): ParseReturnType<T[number]>
Parameters
- input: ParseInput
Returns ParseReturnType<T[number]>
Overrides ZodType._parse
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:778

_parseAsync

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

_parseSync

_parseSync(input): SyncParseReturnType<T[number]>
Parameters
- input: ParseInput
Returns SyncParseReturnType<T[number]>
Inherited from ZodType._parseSync
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:60

_processInputParams

_processInputParams(input): {
ctx: ParseContext;
status: ParseStatus;
}
Parameters
- input: ParseInput
Returns {
ctx: ParseContext;
status: ParseStatus;
}
- ctx: ParseContext
- status: ParseStatus
Inherited from ZodType._processInputParams
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:56

_refinement

_refinement(refinement): ZodEffects<ZodEnum<T>, T[number], T[number]>
Parameters
- refinement: ((arg: T[number], ctx: RefinementCtx) => any)
  - - (arg, ctx): any
    - Parameters
      arg: T[number]
      ctx: RefinementCtx
      Returns any
Returns ZodEffects<ZodEnum<T>, T[number], T[number]>
Inherited from ZodType._refinement
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:72

and

and<T>(incoming): 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/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:83

array

array(): ZodArray<ZodEnum<T>, "many">
Returns ZodArray<ZodEnum<T>, "many">
Inherited from ZodType.array
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:80

brand

brand<B>(brand?): 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/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:87

catch

catch(def): ZodCatch<ZodEnum<T>>
Parameters
- def: T[number]
Returns ZodCatch<ZodEnum<T>>
Inherited from ZodType.catch
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:88
catch(def): ZodCatch<ZodEnum<T>>
Parameters
- def: ((ctx: {
  error: ZodError<any>;
  input: T[number];
  }) => T[number])
  - - (ctx): T[number]
    - Parameters
      ctx: {
      error: ZodError<any>;
      input: T[number];
      }
      error: ZodError<any>
      input: T[number]
      Returns T[number]
Returns ZodCatch<ZodEnum<T>>
Inherited from ZodType.catch
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:89

default

default(def): ZodDefault<ZodEnum<T>>
Parameters
- def: noUndefined<T[number]>
Returns ZodDefault<ZodEnum<T>>
Inherited from ZodType.default
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:85
default(def): ZodDefault<ZodEnum<T>>
Parameters
- def: (() => noUndefined<T[number]>)
  - - (): noUndefined<T[number]>
    - Returns noUndefined<T[number]>
Returns ZodDefault<ZodEnum<T>>
Inherited from ZodType.default
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:86

describe

describe(description): this
Parameters
- description: string
Returns this
Inherited from ZodType.describe
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:93

exclude

exclude<ToExclude>(values, newDef?): 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/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:784

extract

extract<ToExtract>(values, newDef?): 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/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:783

isNullable

isNullable(): boolean
Returns boolean
Inherited from ZodType.isNullable
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:97

isOptional

isOptional(): boolean
Returns boolean
Inherited from ZodType.isOptional
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:96

nullable

nullable(): ZodNullable<ZodEnum<T>>
Returns ZodNullable<ZodEnum<T>>
Inherited from ZodType.nullable
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:78

nullish

nullish(): ZodOptional<ZodNullable<ZodEnum<T>>>
Returns ZodOptional<ZodNullable<ZodEnum<T>>>
Inherited from ZodType.nullish
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:79

optional

optional(): ZodOptional<ZodEnum<T>>
Returns ZodOptional<ZodEnum<T>>
Inherited from ZodType.optional
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:77

or

or<T>(option): 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/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:82

parse

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

parseAsync

parseAsync(data, params?): Promise<T[number]>
Parameters
- data: unknown
- Optionalparams: Partial<ParseParams>
Returns Promise<T[number]>
Inherited from ZodType.parseAsync
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:64

pipe

pipe<T>(target): 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/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:94

promise

promise(): ZodPromise<ZodEnum<T>>
Returns ZodPromise<ZodEnum<T>>
Inherited from ZodType.promise
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:81

readonly

readonly(): ZodReadonly<ZodEnum<T>>
Returns ZodReadonly<ZodEnum<T>>
Inherited from ZodType.readonly
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:95

refine

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

refinement

refinement<RefinedOutput>(check, refinementData): ZodEffects<ZodEnum<T>, RefinedOutput, T[number]>
Type Parameters
- RefinedOutput extends string
Parameters
- check: ((arg: T[number]) => arg is RefinedOutput)
  - - (arg): arg is RefinedOutput
    - Parameters
      arg: T[number]
      Returns 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/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:70
refinement(check, refinementData): ZodEffects<ZodEnum<T>, T[number], T[number]>
Parameters
- check: ((arg: T[number]) => boolean)
  - - (arg): boolean
    - Parameters
      arg: T[number]
      Returns 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/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:71

safeParse

safeParse(data, params?): SafeParseReturnType<T[number], T[number]>
Parameters
- data: unknown
- Optionalparams: Partial<ParseParams>
Returns SafeParseReturnType<T[number], T[number]>
Inherited from ZodType.safeParse
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:63

safeParseAsync

safeParseAsync(data, params?): Promise<SafeParseReturnType<T[number], T[number]>>
Parameters
- data: unknown
- Optionalparams: Partial<ParseParams>
Returns Promise<SafeParseReturnType<T[number], T[number]>>
Inherited from ZodType.safeParseAsync
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:65

superRefine

superRefine<RefinedOutput>(refinement): ZodEffects<ZodEnum<T>, RefinedOutput, T[number]>
Type Parameters
- RefinedOutput extends string
Parameters
- refinement: ((arg: T[number], ctx: RefinementCtx) => arg is RefinedOutput)
  - - (arg, ctx): arg is RefinedOutput
    - Parameters
      arg: T[number]
      ctx: RefinementCtx
      Returns arg is RefinedOutput
Returns ZodEffects<ZodEnum<T>, RefinedOutput, T[number]>
Inherited from ZodType.superRefine
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:73
superRefine(refinement): ZodEffects<ZodEnum<T>, T[number], T[number]>
Parameters
- refinement: ((arg: T[number], ctx: RefinementCtx) => void)
  - - (arg, ctx): void
    - Parameters
      arg: T[number]
      ctx: RefinementCtx
      Returns void
Returns ZodEffects<ZodEnum<T>, T[number], T[number]>
Inherited from ZodType.superRefine
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:74
superRefine(refinement): ZodEffects<ZodEnum<T>, T[number], T[number]>
Parameters
- refinement: ((arg: T[number], ctx: RefinementCtx) => Promise<void>)
  - - (arg, ctx): Promise<void>
    - Parameters
      arg: T[number]
      ctx: RefinementCtx
      Returns Promise<void>
Returns ZodEffects<ZodEnum<T>, T[number], T[number]>
Inherited from ZodType.superRefine
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:75

transform

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

Class ZodEnum<T>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ZodEnum<T>

Properties

Readonly_def

Readonly_input

Readonly_output

Readonly_type

spa

Staticcreate

Accessors

Enum

Returns Values<T>

Values

Returns Values<T>

description

Returns undefined | string

enum

Returns Values<T>

options

Returns T

Methods

_getOrReturnCtx

Parameters

Returns ParseContext

_getType

Parameters

Returns string

_parse

Parameters

Returns ParseReturnType<T[number]>

_parseAsync

Parameters

Returns AsyncParseReturnType<T[number]>

_parseSync

Parameters

Returns SyncParseReturnType<T[number]>

_processInputParams

Parameters

Returns { ctx: ParseContext; status: ParseStatus; }

ctx: ParseContext

status: ParseStatus

_refinement

Parameters

Parameters

Returns any

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

and

Type Parameters

Parameters

Returns ZodIntersection<ZodEnum<T>, T>

array

Returns ZodArray<ZodEnum<T>, "many">

brand

Type Parameters

Parameters

Returns ZodBranded<ZodEnum<T>, B>

catch

Parameters

Returns ZodCatch<ZodEnum<T>>

Parameters

Parameters

error: ZodError<any>

input: T[number]

Returns T[number]

Returns ZodCatch<ZodEnum<T>>

default

Parameters

Returns ZodDefault<ZodEnum<T>>

Parameters

`Readonly`_def

`Readonly`_input

`Readonly`_output

`Readonly`_type

`Static`create

Returns {
ctx: ParseContext;
status: ParseStatus;
}