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