title: Core.z. Zod Enum
A2A Node SDK - v0.1.0 / Modules / Core / z / ZodEnum
Class: ZodEnum<T>
Type parameters
| Name | Type |
|---|---|
T | extends [string, …string[]] |
Hierarchy
-
ZodType<T[number],ZodEnumDef<T>,T[number]>↳
ZodEnum
Table of contents
Constructors
Properties
Accessors
Methods
- _getOrReturnCtx
- _getType
- _parse
- _parseAsync
- _parseSync
- _processInputParams
- _refinement
- and
- array
- brand
- catch
- default
- describe
- exclude
- extract
- isNullable
- isOptional
- nullable
- nullish
- optional
- or
- parse
- parseAsync
- pipe
- promise
- readonly
- refine
- refinement
- safeParse
- safeParseAsync
- superRefine
- transform
- ~validate
Constructors
constructor
• new ZodEnum<T>(def): ZodEnum<T>
Type parameters
| Name | Type |
|---|---|
T | extends [string, …string[]] |
Parameters
| Name | Type |
|---|---|
def | ZodEnumDef<T> |
Returns
ZodEnum<T>
Inherited from
Properties
_def
• Readonly _def: ZodEnumDef<T>
Inherited from
_input
• Readonly _input: T[number]
Inherited from
_output
• Readonly _output: T[number]
Inherited from
_type
• Readonly _type: T[number]
Inherited from
create
▪ Static create: <U, T>(values: T, params?: RawCreateParams) => ZodEnum<Writeable<T>><U, T>(values: T, params?: RawCreateParams) => ZodEnum<T>
Type declaration
▸ <U, T>(values, params?): ZodEnum<Writeable<T>>
Type parameters
| Name | Type |
|---|---|
U | extends string |
T | extends readonly [U, U] |
Parameters
| Name | Type |
|---|---|
values | T |
params? | RawCreateParams |
Returns
▸ <U, T>(values, params?): ZodEnum<T>
Type parameters
| Name | Type |
|---|---|
U | extends string |
T | extends [U, …U[]] |
Parameters
| Name | Type |
|---|---|
values | T |
params? | RawCreateParams |
Returns
ZodEnum<T>
spa
• spa: (data: unknown, params?: InexactPartial<ParseParams>) => Promise<SafeParseReturnType<T[number], T[number]>>
Alias of safeParseAsync
Type declaration
▸ (data, params?): Promise<SafeParseReturnType<T[number], T[number]>>
Parameters
| Name | Type |
|---|---|
data | unknown |
params? | InexactPartial<ParseParams> |
Returns
Promise<SafeParseReturnType<T[number], T[number]>>
Inherited from
~standard
• ~standard: Props<T[number], T[number]>
Inherited from
Accessors
Enum
• get Enum(): Values<T>
Returns
Values<T>
Values
• get Values(): Values<T>
Returns
Values<T>
description
• get description(): undefined | string
Returns
undefined | string
Inherited from
ZodType.description
enum
• get enum(): Values<T>
Returns
Values<T>
options
• get options(): T
Returns
T
Methods
_getOrReturnCtx
▸ _getOrReturnCtx(input, ctx?): ParseContext
Parameters
| Name | Type |
|---|---|
input | ParseInput |
ctx? | ParseContext |
Returns
Inherited from
_getType
▸ _getType(input): string
Parameters
| Name | Type |
|---|---|
input | ParseInput |
Returns
string
Inherited from
_parse
▸ _parse(input): ParseReturnType<T[number]>
Parameters
| Name | Type |
|---|---|
input | ParseInput |
Returns
ParseReturnType<T[number]>
Overrides
_parseAsync
▸ _parseAsync(input): AsyncParseReturnType<T[number]>
Parameters
| Name | Type |
|---|---|
input | ParseInput |
Returns
AsyncParseReturnType<T[number]>
Inherited from
_parseSync
▸ _parseSync(input): SyncParseReturnType<T[number]>
Parameters
| Name | Type |
|---|---|
input | ParseInput |
Returns
SyncParseReturnType<T[number]>
Inherited from
_processInputParams
▸ _processInputParams(input): Object
Parameters
| Name | Type |
|---|---|
input | ParseInput |
Returns
Object
| Name | Type |
|---|---|
ctx | ParseContext |
status | ParseStatus |
Inherited from
_refinement
▸ _refinement(refinement): ZodEffects<ZodEnum<T>, T[number], T[number]>
Parameters
| Name | Type |
|---|---|
refinement | (arg: T[number], ctx: RefinementCtx) => any |
Returns
ZodEffects<ZodEnum<T>, T[number], T[number]>
Inherited from
and
▸ and<T>(incoming): ZodIntersection<ZodEnum<T>, T>
Type parameters
| Name | Type |
|---|---|
T | extends ZodTypeAny |
Parameters
| Name | Type |
|---|---|
incoming | T |
Returns
ZodIntersection<ZodEnum<T>, T>
Inherited from
array
▸ array(): ZodArray<ZodEnum<T>, "many">
Returns
Inherited from
brand
▸ brand<B>(brand?): ZodBranded<ZodEnum<T>, B>
Type parameters
| Name | Type |
|---|---|
B | extends string | number | symbol |
Parameters
| Name | Type |
|---|---|
brand? | B |
Returns
ZodBranded<ZodEnum<T>, B>
Inherited from
catch
▸ catch(def): ZodCatch<ZodEnum<T>>
Parameters
| Name | Type |
|---|---|
def | T[number] |
Returns
Inherited from
▸ catch(def): ZodCatch<ZodEnum<T>>
Parameters
| Name | Type |
|---|---|
def | (ctx: { error: ZodError<any> ; input: T[number] }) => T[number] |
Returns
Inherited from
default
▸ default(def): ZodDefault<ZodEnum<T>>
Parameters
| Name | Type |
|---|---|
def | noUndefined<T[number]> |
Returns
ZodDefault<ZodEnum<T>>
Inherited from
▸ default(def): ZodDefault<ZodEnum<T>>
Parameters
| Name | Type |
|---|---|
def | () => noUndefined<T[number]> |
Returns
ZodDefault<ZodEnum<T>>
Inherited from
describe
▸ describe(description): this
Parameters
| Name | Type |
|---|---|
description | string |
Returns
this
Inherited from
exclude
▸ exclude<ToExclude>(values, newDef?): ZodEnum<typecast<Writeable<FilterEnum<T, ToExclude[number]>>, [string, …string[]]>>
Type parameters
| Name | Type |
|---|---|
ToExclude | extends readonly [T[number], T[number]] |
Parameters
| Name | Type |
|---|---|
values | ToExclude |
newDef? | RawCreateParams |
Returns
ZodEnum<typecast<Writeable<FilterEnum<T, ToExclude[number]>>, [string, …string[]]>>
extract
▸ extract<ToExtract>(values, newDef?): ZodEnum<Writeable<ToExtract>>
Type parameters
| Name | Type |
|---|---|
ToExtract | extends readonly [T[number], T[number]] |
Parameters
| Name | Type |
|---|---|
values | ToExtract |
newDef? | RawCreateParams |
Returns
isNullable
▸ isNullable(): boolean
Returns
boolean
Inherited from
isOptional
▸ isOptional(): boolean
Returns
boolean
Inherited from
nullable
▸ nullable(): ZodNullable<ZodEnum<T>>
Returns
ZodNullable<ZodEnum<T>>
Inherited from
nullish
▸ nullish(): ZodOptional<ZodNullable<ZodEnum<T>>>
Returns
ZodOptional<ZodNullable<ZodEnum<T>>>
Inherited from
optional
▸ optional(): ZodOptional<ZodEnum<T>>
Returns
ZodOptional<ZodEnum<T>>
Inherited from
or
▸ or<T>(option): ZodUnion<[ZodEnum<T>, T]>
Type parameters
| Name | Type |
|---|---|
T | extends ZodTypeAny |
Parameters
| Name | Type |
|---|---|
option | T |
Returns
Inherited from
parse
▸ parse(data, params?): T[number]
Parameters
| Name | Type |
|---|---|
data | unknown |
params? | InexactPartial<ParseParams> |
Returns
T[number]
Inherited from
parseAsync
▸ parseAsync(data, params?): Promise<T[number]>
Parameters
| Name | Type |
|---|---|
data | unknown |
params? | InexactPartial<ParseParams> |
Returns
Promise<T[number]>
Inherited from
pipe
▸ pipe<T>(target): ZodPipeline<ZodEnum<T>, T>
Type parameters
| Name | Type |
|---|---|
T | extends ZodTypeAny |
Parameters
| Name | Type |
|---|---|
target | T |
Returns
ZodPipeline<ZodEnum<T>, T>
Inherited from
promise
▸ promise(): ZodPromise<ZodEnum<T>>
Returns
ZodPromise<ZodEnum<T>>
Inherited from
readonly
▸ readonly(): ZodReadonly<ZodEnum<T>>
Returns
ZodReadonly<ZodEnum<T>>
Inherited from
refine
▸ refine<RefinedOutput>(check, message?): ZodEffects<ZodEnum<T>, RefinedOutput, T[number]>
Type parameters
| Name | Type |
|---|---|
RefinedOutput | extends string |
Parameters
| Name | Type |
|---|---|
check | (arg: T[number]) => arg is RefinedOutput |
message? | string | Partial<Omit<ZodCustomIssue, "code">> | (arg: T[number]) => Partial<Omit<ZodCustomIssue, "code">> |
Returns
ZodEffects<ZodEnum<T>, RefinedOutput, T[number]>
Inherited from
▸ refine(check, message?): ZodEffects<ZodEnum<T>, T[number], T[number]>
Parameters
| Name | Type |
|---|---|
check | (arg: T[number]) => unknown |
message? | string | Partial<Omit<ZodCustomIssue, "code">> | (arg: T[number]) => Partial<Omit<ZodCustomIssue, "code">> |
Returns
ZodEffects<ZodEnum<T>, T[number], T[number]>
Inherited from
refinement
▸ refinement<RefinedOutput>(check, refinementData): ZodEffects<ZodEnum<T>, RefinedOutput, T[number]>
Type parameters
| Name | Type |
|---|---|
RefinedOutput | extends string |
Parameters
| Name | Type |
|---|---|
check | (arg: T[number]) => arg is RefinedOutput |
refinementData | IssueData | (arg: T[number], ctx: RefinementCtx) => IssueData |
Returns
ZodEffects<ZodEnum<T>, RefinedOutput, T[number]>
Inherited from
▸ refinement(check, refinementData): ZodEffects<ZodEnum<T>, T[number], T[number]>
Parameters
| Name | Type |
|---|---|
check | (arg: T[number]) => boolean |
refinementData | IssueData | (arg: T[number], ctx: RefinementCtx) => IssueData |
Returns
ZodEffects<ZodEnum<T>, T[number], T[number]>
Inherited from
safeParse
▸ safeParse(data, params?): SafeParseReturnType<T[number], T[number]>
Parameters
| Name | Type |
|---|---|
data | unknown |
params? | InexactPartial<ParseParams> |
Returns
SafeParseReturnType<T[number], T[number]>
Inherited from
safeParseAsync
▸ safeParseAsync(data, params?): Promise<SafeParseReturnType<T[number], T[number]>>
Parameters
| Name | Type |
|---|---|
data | unknown |
params? | InexactPartial<ParseParams> |
Returns
Promise<SafeParseReturnType<T[number], T[number]>>
Inherited from
superRefine
▸ superRefine<RefinedOutput>(refinement): ZodEffects<ZodEnum<T>, RefinedOutput, T[number]>
Type parameters
| Name | Type |
|---|---|
RefinedOutput | extends string |
Parameters
| Name | Type |
|---|---|
refinement | (arg: T[number], ctx: RefinementCtx) => arg is RefinedOutput |
Returns
ZodEffects<ZodEnum<T>, RefinedOutput, T[number]>
Inherited from
▸ superRefine(refinement): ZodEffects<ZodEnum<T>, T[number], T[number]>
Parameters
| Name | Type |
|---|---|
refinement | (arg: T[number], ctx: RefinementCtx) => void |
Returns
ZodEffects<ZodEnum<T>, T[number], T[number]>
Inherited from
▸ superRefine(refinement): ZodEffects<ZodEnum<T>, T[number], T[number]>
Parameters
| Name | Type |
|---|---|
refinement | (arg: T[number], ctx: RefinementCtx) => Promise<void> |
Returns
ZodEffects<ZodEnum<T>, T[number], T[number]>
Inherited from
transform
▸ transform<NewOut>(transform): ZodEffects<ZodEnum<T>, NewOut, T[number]>
Type parameters
| Name |
|---|
NewOut |
Parameters
| Name | Type |
|---|---|
transform | (arg: T[number], ctx: RefinementCtx) => NewOut | Promise<NewOut> |
Returns
ZodEffects<ZodEnum<T>, NewOut, T[number]>
Inherited from
~validate
▸ ~validate(data): Result<T[number]> | Promise<Result<T[number]>>
Parameters
| Name | Type |
|---|---|
data | unknown |
Returns
Result<T[number]> | Promise<Result<T[number]>>