title: Core.z. Zod Optional

A2A Node SDK - v0.1.0 / Modules / Core / z / ZodOptional

Class: ZodOptional<T>

Core.z.ZodOptional

Type parameters

Name	Type
`T`	extends `ZodTypeAny`

Hierarchy

ZodType<T["_output"] | undefined, ZodOptionalDef<T>, T["_input"] | undefined>

↳ ZodOptional

Constructors

constructor

Properties

Accessors

description

Methods

Constructors

constructor

• new ZodOptional<T>(def): ZodOptional<T>

Type parameters

Name	Type
`T`	extends `ZodTypeAny`

Parameters

Name	Type
`def`	`ZodOptionalDef`<`T`>

Returns

ZodOptional<T>

Inherited from

ZodType.constructor

Properties

_def

• Readonly _def: ZodOptionalDef<T>

Inherited from

ZodType._def

_input

• Readonly _input: undefined | T["_input"]

Inherited from

ZodType._input

_output

• Readonly _output: undefined | T["_output"]

Inherited from

ZodType._output

_type

• Readonly _type: undefined | T["_output"]

Inherited from

ZodType._type

create

▪ Static create: <Inner>(type: Inner, params?: RawCreateParams) => ZodOptional<Inner>

Type declaration

▸ <Inner>(type, params?): ZodOptional<Inner>

Type parameters

Name	Type
`Inner`	extends `ZodTypeAny`

Parameters

Name	Type
`type`	`Inner`
`params?`	`RawCreateParams`

Returns

ZodOptional<Inner>

spa

• spa: (data: unknown, params?: InexactPartial<ParseParams>) => Promise<SafeParseReturnType<undefined | T["_input"], undefined | T["_output"]>>

Alias of safeParseAsync

Type declaration

▸ (data, params?): Promise<SafeParseReturnType<undefined | T["_input"], undefined | T["_output"]>>

Parameters

Name	Type
`data`	`unknown`
`params?`	`InexactPartial`<`ParseParams`>

Returns

Promise<SafeParseReturnType<undefined | T["_input"], undefined | T["_output"]>>

Inherited from

ZodType.spa

~standard

• ~standard: Props<undefined | T["_input"], undefined | T["_output"]>

Inherited from

ZodType.~standard

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

ParseContext

Inherited from

ZodType._getOrReturnCtx

_getType

▸ _getType(input): string

Parameters

Name	Type
`input`	`ParseInput`

Returns

string

Inherited from

ZodType._getType

_parse

▸ _parse(input): ParseReturnType<undefined | T["_output"]>

Parameters

Name	Type
`input`	`ParseInput`

Returns

ParseReturnType<undefined | T["_output"]>

Overrides

ZodType._parse

_parseAsync

▸ _parseAsync(input): AsyncParseReturnType<undefined | T["_output"]>

Parameters

Name	Type
`input`	`ParseInput`

Returns

AsyncParseReturnType<undefined | T["_output"]>

Inherited from

ZodType._parseAsync

_parseSync

▸ _parseSync(input): SyncParseReturnType<undefined | T["_output"]>

Parameters

Name	Type
`input`	`ParseInput`

Returns

SyncParseReturnType<undefined | T["_output"]>

Inherited from

ZodType._parseSync

_processInputParams

▸ _processInputParams(input): Object

Parameters

Name	Type
`input`	`ParseInput`

Returns

Object

Name	Type
`ctx`	`ParseContext`
`status`	`ParseStatus`

Inherited from

ZodType._processInputParams

_refinement

▸ _refinement(refinement): ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>

Parameters

Name	Type
`refinement`	(`arg`: `undefined` \| `T`[`"_output"`], `ctx`: `RefinementCtx`) => `any`

Returns

ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>

Inherited from

ZodType._refinement

and

▸ and<T>(incoming): ZodIntersection<ZodOptional<T>, T>

Type parameters

Name	Type
`T`	extends `ZodTypeAny`

Parameters

Name	Type
`incoming`	`T`

Returns

ZodIntersection<ZodOptional<T>, T>

Inherited from

ZodType.and

array

▸ array(): ZodArray<ZodOptional<T>, "many">

Returns

ZodArray<ZodOptional<T>, "many">

Inherited from

ZodType.array

brand

▸ brand<B>(brand?): ZodBranded<ZodOptional<T>, B>

Type parameters

Name	Type
`B`	extends `string` \| `number` \| `symbol`

Parameters

Name	Type
`brand?`	`B`

Returns

ZodBranded<ZodOptional<T>, B>

Inherited from

ZodType.brand

catch

▸ catch(def): ZodCatch<ZodOptional<T>>

Parameters

Name	Type
`def`	`undefined` \| `T`[`"_output"`]

Returns

ZodCatch<ZodOptional<T>>

Inherited from

ZodType.catch

▸ catch(def): ZodCatch<ZodOptional<T>>

Parameters

Name	Type
`def`	(`ctx`: { `error`: `ZodError`<`any`> ; `input`: `undefined` \| `T`[`"_input"`] }) => `undefined` \| `T`[`"_output"`]

Returns

ZodCatch<ZodOptional<T>>

Inherited from

ZodType.catch

default

▸ default(def): ZodDefault<ZodOptional<T>>

Parameters

Name	Type
`def`	`noUndefined`<`T`[`"_input"`]>

Returns

ZodDefault<ZodOptional<T>>

Inherited from

ZodType.default

▸ default(def): ZodDefault<ZodOptional<T>>

Parameters

Name	Type
`def`	() => `noUndefined`<`T`[`"_input"`]>

Returns

ZodDefault<ZodOptional<T>>

Inherited from

ZodType.default

describe

▸ describe(description): this

Parameters

Name	Type
`description`	`string`

Returns

this

Inherited from

ZodType.describe

isNullable

▸ isNullable(): boolean

Returns

boolean

Inherited from

ZodType.isNullable

isOptional

▸ isOptional(): boolean

Returns

boolean

Inherited from

ZodType.isOptional

nullable

▸ nullable(): ZodNullable<ZodOptional<T>>

optional

▸ optional(): ZodOptional<ZodOptional<T>>

Returns

ZodOptional<ZodOptional<T>>

Inherited from

ZodType.optional

or

▸ or<T>(option): ZodUnion<[ZodOptional<T>, T]>

Type parameters

Name	Type
`T`	extends `ZodTypeAny`

Parameters

Name	Type
`option`	`T`

Returns

ZodUnion<[ZodOptional<T>, T]>

Inherited from

ZodType.or

parse

▸ parse(data, params?): undefined | T["_output"]

Parameters

Name	Type
`data`	`unknown`
`params?`	`InexactPartial`<`ParseParams`>

Returns

undefined | T["_output"]

Inherited from

ZodType.parse

parseAsync

▸ parseAsync(data, params?): Promise<undefined | T["_output"]>

Parameters

Name	Type
`data`	`unknown`
`params?`	`InexactPartial`<`ParseParams`>

Returns

Promise<undefined | T["_output"]>

Inherited from

ZodType.parseAsync

pipe

▸ pipe<T>(target): ZodPipeline<ZodOptional<T>, T>

Type parameters

Name	Type
`T`	extends `ZodTypeAny`

Parameters

Name	Type
`target`	`T`

Returns

ZodPipeline<ZodOptional<T>, T>

Inherited from

ZodType.pipe

promise

▸ promise(): ZodPromise<ZodOptional<T>>

Returns

ZodPromise<ZodOptional<T>>

Inherited from

ZodType.promise

readonly

▸ readonly(): ZodReadonly<ZodOptional<T>>

Returns

ZodReadonly<ZodOptional<T>>

Inherited from

ZodType.readonly

refine

▸ refine<RefinedOutput>(check, message?): ZodEffects<ZodOptional<T>, RefinedOutput, undefined | T["_input"]>

Type parameters

Name	Type
`RefinedOutput`	extends `any`

Parameters

Name	Type
`check`	(`arg`: `undefined` \| `T`[`"_output"`]) => arg is RefinedOutput
`message?`	`string` \| `Partial`<`Omit`<`ZodCustomIssue`, `"code"`>> \| (`arg`: `undefined` \| `T`[`"_output"`]) => `Partial`<`Omit`<`ZodCustomIssue`, `"code"`>>

Returns

ZodEffects<ZodOptional<T>, RefinedOutput, undefined | T["_input"]>

Inherited from

ZodType.refine

▸ refine(check, message?): ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>

Parameters

Name	Type
`check`	(`arg`: `undefined` \| `T`[`"_output"`]) => `unknown`
`message?`	`string` \| `Partial`<`Omit`<`ZodCustomIssue`, `"code"`>> \| (`arg`: `undefined` \| `T`[`"_output"`]) => `Partial`<`Omit`<`ZodCustomIssue`, `"code"`>>

Returns

ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>

Inherited from

ZodType.refine

refinement

▸ refinement<RefinedOutput>(check, refinementData): ZodEffects<ZodOptional<T>, RefinedOutput, undefined | T["_input"]>

Type parameters

Name	Type
`RefinedOutput`	extends `any`

Parameters

Name	Type
`check`	(`arg`: `undefined` \| `T`[`"_output"`]) => arg is RefinedOutput
`refinementData`	`IssueData` \| (`arg`: `undefined` \| `T`[`"_output"`], `ctx`: `RefinementCtx`) => `IssueData`

Returns

ZodEffects<ZodOptional<T>, RefinedOutput, undefined | T["_input"]>

Inherited from

ZodType.refinement

▸ refinement(check, refinementData): ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>

Parameters

Name	Type
`check`	(`arg`: `undefined` \| `T`[`"_output"`]) => `boolean`
`refinementData`	`IssueData` \| (`arg`: `undefined` \| `T`[`"_output"`], `ctx`: `RefinementCtx`) => `IssueData`

Returns

ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>

Inherited from

ZodType.refinement

safeParse

▸ safeParse(data, params?): SafeParseReturnType<undefined | T["_input"], undefined | T["_output"]>

Parameters

Name	Type
`data`	`unknown`
`params?`	`InexactPartial`<`ParseParams`>

Returns

SafeParseReturnType<undefined | T["_input"], undefined | T["_output"]>

Inherited from

ZodType.safeParse

safeParseAsync

▸ safeParseAsync(data, params?): Promise<SafeParseReturnType<undefined | T["_input"], undefined | T["_output"]>>

Parameters

Name	Type
`data`	`unknown`
`params?`	`InexactPartial`<`ParseParams`>

Returns

Promise<SafeParseReturnType<undefined | T["_input"], undefined | T["_output"]>>

Inherited from

ZodType.safeParseAsync

superRefine

▸ superRefine<RefinedOutput>(refinement): ZodEffects<ZodOptional<T>, RefinedOutput, undefined | T["_input"]>

Type parameters

Name	Type
`RefinedOutput`	extends `any`

Parameters

Name	Type
`refinement`	(`arg`: `undefined` \| `T`[`"_output"`], `ctx`: `RefinementCtx`) => arg is RefinedOutput

Returns

ZodEffects<ZodOptional<T>, RefinedOutput, undefined | T["_input"]>

Inherited from

ZodType.superRefine

▸ superRefine(refinement): ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>

Parameters

Name	Type
`refinement`	(`arg`: `undefined` \| `T`[`"_output"`], `ctx`: `RefinementCtx`) => `void`

Returns

ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>

Inherited from

ZodType.superRefine

▸ superRefine(refinement): ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>

Parameters

Name	Type
`refinement`	(`arg`: `undefined` \| `T`[`"_output"`], `ctx`: `RefinementCtx`) => `Promise`<`void`>

Returns

ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>

Inherited from

ZodType.superRefine

transform

▸ transform<NewOut>(transform): ZodEffects<ZodOptional<T>, NewOut, undefined | T["_input"]>

Type parameters

Name
`NewOut`

Parameters

Name	Type
`transform`	(`arg`: `undefined` \| `T`[`"_output"`], `ctx`: `RefinementCtx`) => `NewOut` \| `Promise`<`NewOut`>

Returns

ZodEffects<ZodOptional<T>, NewOut, undefined | T["_input"]>

Inherited from

ZodType.transform

unwrap

▸ unwrap(): T

Returns

T

~validate

▸ ~validate(data): Result<undefined | T["_output"]> | Promise<Result<undefined | T["_output"]>>

Parameters

Name	Type
`data`	`unknown`

Returns

Result<undefined | T["_output"]> | Promise<Result<undefined | T["_output"]>>

Inherited from

ZodType.~validate

z.ZodObject z.ZodPipeline

title: Core.z. Zod Optional

Class: ZodOptional<T>

Type parameters

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type parameters

Parameters

Returns

Inherited from

Properties

_def

Inherited from

_input

Inherited from

_output

Inherited from

_type

Inherited from

create

Type declaration

Type parameters

Parameters

Returns

spa

Type declaration

Parameters

Returns

Inherited from

~standard

Inherited from

Accessors

description

Returns

Inherited from

Methods

_getOrReturnCtx

Parameters

Returns

Inherited from

_getType

Parameters

Returns

Inherited from

_parse

Parameters

Returns

Overrides

_parseAsync

Parameters

Returns

Inherited from

_parseSync

Parameters

Returns

Inherited from

_processInputParams

Parameters

Returns

Inherited from

_refinement

Parameters

Returns

Inherited from

and

Type parameters

Parameters

Returns

Inherited from

array

Returns

Inherited from

brand

Type parameters

Parameters