title: Core.z. Zod Symbol

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

Class: ZodSymbol

Core.z.ZodSymbol

Hierarchy

ZodType<symbol, ZodSymbolDef, symbol>

↳ ZodSymbol

Constructors

constructor

Properties

Accessors

description

Methods

Constructors

constructor

• new ZodSymbol(def): ZodSymbol

Parameters

Name	Type
`def`	`ZodSymbolDef`

Returns

ZodSymbol

Inherited from

ZodType.constructor

Properties

_def

• Readonly _def: ZodSymbolDef

Inherited from

ZodType._def

_input

• Readonly _input: symbol

Inherited from

ZodType._input

_output

• Readonly _output: symbol

Inherited from

ZodType._output

_type

• Readonly _type: symbol

Inherited from

ZodType._type

create

▪ Static create: (params?: RawCreateParams) => ZodSymbol

Type declaration

▸ (params?): ZodSymbol

Parameters

Name	Type
`params?`	`RawCreateParams`

Returns

ZodSymbol

spa

• spa: (data: unknown, params?: InexactPartial<ParseParams>) => Promise<SafeParseReturnType<symbol, symbol>>

Alias of safeParseAsync

Type declaration

▸ (data, params?): Promise<SafeParseReturnType<symbol, symbol>>

Parameters

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

Returns

Promise<SafeParseReturnType<symbol, symbol>>

Inherited from

ZodType.spa

~standard

• ~standard: Props<symbol, symbol>

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<symbol>

Parameters

Name	Type
`input`	`ParseInput`

Returns

ParseReturnType<symbol>

Overrides

ZodType._parse

_parseAsync

▸ _parseAsync(input): AsyncParseReturnType<symbol>

Parameters

Name	Type
`input`	`ParseInput`

Returns

AsyncParseReturnType<symbol>

Inherited from

ZodType._parseAsync

_parseSync

▸ _parseSync(input): SyncParseReturnType<symbol>

Parameters

Name	Type
`input`	`ParseInput`

Returns

SyncParseReturnType<symbol>

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<ZodSymbol, symbol, symbol>

Parameters

Name	Type
`refinement`	(`arg`: `symbol`, `ctx`: `RefinementCtx`) => `any`

Returns

ZodEffects<ZodSymbol, symbol, symbol>

Inherited from

ZodType._refinement

and

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

Type parameters

Name	Type
`T`	extends `ZodTypeAny`

Parameters

Name	Type
`incoming`	`T`

Returns

ZodIntersection<ZodSymbol, T>

Inherited from

ZodType.and

array

▸ array(): ZodArray<ZodSymbol, "many">

Returns

ZodArray<ZodSymbol, "many">

Inherited from

ZodType.array

brand

▸ brand<B>(brand?): ZodBranded<ZodSymbol, B>

Type parameters

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

Parameters

Name	Type
`brand?`	`B`

Returns

ZodBranded<ZodSymbol, B>

Inherited from

ZodType.brand

catch

▸ catch(def): ZodCatch<ZodSymbol>

Parameters

Name	Type
`def`	`symbol`

Returns

ZodCatch<ZodSymbol>

Inherited from

ZodType.catch

▸ catch(def): ZodCatch<ZodSymbol>

Parameters

Name	Type
`def`	(`ctx`: { `error`: `ZodError`<`any`> ; `input`: `symbol` }) => `symbol`

Returns

ZodCatch<ZodSymbol>

Inherited from

ZodType.catch

default

▸ default(def): ZodDefault<ZodSymbol>

Parameters

Name	Type
`def`	`symbol`

Returns

ZodDefault<ZodSymbol>

Inherited from

ZodType.default

▸ default(def): ZodDefault<ZodSymbol>

Parameters

Name	Type
`def`	() => `symbol`

Returns

ZodDefault<ZodSymbol>

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

or

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

Type parameters

Name	Type
`T`	extends `ZodTypeAny`

Parameters

Name	Type
`option`	`T`

Returns

ZodUnion<[ZodSymbol, T]>

Inherited from

ZodType.or

parse

▸ parse(data, params?): symbol

Parameters

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

Returns

symbol

Inherited from

ZodType.parse

parseAsync

▸ parseAsync(data, params?): Promise<symbol>

Parameters

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

Returns

Promise<symbol>

Inherited from

ZodType.parseAsync

pipe

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

Type parameters

Name	Type
`T`	extends `ZodTypeAny`

Parameters

Name	Type
`target`	`T`

Returns

ZodPipeline<ZodSymbol, T>

Inherited from

ZodType.pipe

promise

▸ promise(): ZodPromise<ZodSymbol>

Returns

ZodPromise<ZodSymbol>

Inherited from

ZodType.promise

readonly

▸ readonly(): ZodReadonly<ZodSymbol>

Returns

ZodReadonly<ZodSymbol>

Inherited from

ZodType.readonly

refine

▸ refine<RefinedOutput>(check, message?): ZodEffects<ZodSymbol, RefinedOutput, symbol>

Type parameters

Name	Type
`RefinedOutput`	extends `symbol`

Parameters

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

Returns

ZodEffects<ZodSymbol, RefinedOutput, symbol>

Inherited from

ZodType.refine

▸ refine(check, message?): ZodEffects<ZodSymbol, symbol, symbol>

Parameters

Name	Type
`check`	(`arg`: `symbol`) => `unknown`
`message?`	`string` \| `Partial`<`Omit`<`ZodCustomIssue`, `"code"`>> \| (`arg`: `symbol`) => `Partial`<`Omit`<`ZodCustomIssue`, `"code"`>>

Returns

ZodEffects<ZodSymbol, symbol, symbol>

Inherited from

ZodType.refine

refinement

▸ refinement<RefinedOutput>(check, refinementData): ZodEffects<ZodSymbol, RefinedOutput, symbol>

Type parameters

Name	Type
`RefinedOutput`	extends `symbol`

Parameters

Name	Type
`check`	(`arg`: `symbol`) => arg is RefinedOutput
`refinementData`	`IssueData` \| (`arg`: `symbol`, `ctx`: `RefinementCtx`) => `IssueData`

Returns

ZodEffects<ZodSymbol, RefinedOutput, symbol>

Inherited from

ZodType.refinement

▸ refinement(check, refinementData): ZodEffects<ZodSymbol, symbol, symbol>

Parameters

Name	Type
`check`	(`arg`: `symbol`) => `boolean`
`refinementData`	`IssueData` \| (`arg`: `symbol`, `ctx`: `RefinementCtx`) => `IssueData`

Returns

ZodEffects<ZodSymbol, symbol, symbol>

Inherited from

ZodType.refinement

safeParse

▸ safeParse(data, params?): SafeParseReturnType<symbol, symbol>

Parameters

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

Returns

SafeParseReturnType<symbol, symbol>

Inherited from

ZodType.safeParse

safeParseAsync

▸ safeParseAsync(data, params?): Promise<SafeParseReturnType<symbol, symbol>>

Parameters

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

Returns

Promise<SafeParseReturnType<symbol, symbol>>

Inherited from

ZodType.safeParseAsync

superRefine

▸ superRefine<RefinedOutput>(refinement): ZodEffects<ZodSymbol, RefinedOutput, symbol>

Type parameters

Name	Type
`RefinedOutput`	extends `symbol`

Parameters

Name	Type
`refinement`	(`arg`: `symbol`, `ctx`: `RefinementCtx`) => arg is RefinedOutput

Returns

ZodEffects<ZodSymbol, RefinedOutput, symbol>

Inherited from

ZodType.superRefine

▸ superRefine(refinement): ZodEffects<ZodSymbol, symbol, symbol>

Parameters

Name	Type
`refinement`	(`arg`: `symbol`, `ctx`: `RefinementCtx`) => `void`

Returns

ZodEffects<ZodSymbol, symbol, symbol>

Inherited from

ZodType.superRefine

▸ superRefine(refinement): ZodEffects<ZodSymbol, symbol, symbol>

Parameters

Name	Type
`refinement`	(`arg`: `symbol`, `ctx`: `RefinementCtx`) => `Promise`<`void`>

Returns

ZodEffects<ZodSymbol, symbol, symbol>

Inherited from

ZodType.superRefine

transform

▸ transform<NewOut>(transform): ZodEffects<ZodSymbol, NewOut, symbol>

Type parameters

Name
`NewOut`

Parameters

Name	Type
`transform`	(`arg`: `symbol`, `ctx`: `RefinementCtx`) => `NewOut` \| `Promise`<`NewOut`>

Returns

ZodEffects<ZodSymbol, NewOut, symbol>

Inherited from

ZodType.transform

~validate

▸ ~validate(data): Result<symbol> | Promise<Result<symbol>>

Parameters

Name	Type
`data`	`unknown`

Returns

Result<symbol> | Promise<Result<symbol>>

Inherited from

ZodType.~validate

z.ZodString z.ZodTuple

title: Core.z. Zod Symbol

Class: ZodSymbol

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns

Inherited from

Properties

_def

Inherited from

_input

Inherited from

_output

Inherited from

_type

Inherited from

create

Type declaration

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

Returns

Inherited from

catch