title: Core.z. Zod Void

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

Class: ZodVoid

Core.z.ZodVoid

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new ZodVoid(def): ZodVoid

Parameters

NameType
defZodVoidDef

Returns

ZodVoid

Inherited from

ZodType.constructor

Properties

_def

Readonly _def: ZodVoidDef

Inherited from

ZodType._def


_input

Readonly _input: void

Inherited from

ZodType._input


_output

Readonly _output: void

Inherited from

ZodType._output


_type

Readonly _type: void

Inherited from

ZodType._type


create

Static create: (params?: RawCreateParams) => ZodVoid

Type declaration

▸ (params?): ZodVoid

Parameters
NameType
params?RawCreateParams
Returns

ZodVoid


spa

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

Alias of safeParseAsync

Type declaration

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

Parameters
NameType
dataunknown
params?InexactPartial<ParseParams>
Returns

Promise<SafeParseReturnType<void, void>>

Inherited from

ZodType.spa


~standard

~standard: Props<void, void>

Inherited from

ZodType.~standard

Accessors

description

get description(): undefined | string

Returns

undefined | string

Inherited from

ZodType.description

Methods

_getOrReturnCtx

_getOrReturnCtx(input, ctx?): ParseContext

Parameters

NameType
inputParseInput
ctx?ParseContext

Returns

ParseContext

Inherited from

ZodType._getOrReturnCtx


_getType

_getType(input): string

Parameters

NameType
inputParseInput

Returns

string

Inherited from

ZodType._getType


_parse

_parse(input): ParseReturnType<void>

Parameters

NameType
inputParseInput

Returns

ParseReturnType<void>

Overrides

ZodType._parse


_parseAsync

_parseAsync(input): AsyncParseReturnType<void>

Parameters

NameType
inputParseInput

Returns

AsyncParseReturnType<void>

Inherited from

ZodType._parseAsync


_parseSync

_parseSync(input): SyncParseReturnType<void>

Parameters

NameType
inputParseInput

Returns

SyncParseReturnType<void>

Inherited from

ZodType._parseSync


_processInputParams

_processInputParams(input): Object

Parameters

NameType
inputParseInput

Returns

Object

NameType
ctxParseContext
statusParseStatus

Inherited from

ZodType._processInputParams


_refinement

_refinement(refinement): ZodEffects<ZodVoid, void, void>

Parameters

NameType
refinement(arg: void, ctx: RefinementCtx) => any

Returns

ZodEffects<ZodVoid, void, void>

Inherited from

ZodType._refinement


and

and<T>(incoming): ZodIntersection<ZodVoid, T>

Type parameters

NameType
Textends ZodTypeAny

Parameters

NameType
incomingT

Returns

ZodIntersection<ZodVoid, T>

Inherited from

ZodType.and


array

array(): ZodArray<ZodVoid, "many">

Returns

ZodArray<ZodVoid, "many">

Inherited from

ZodType.array


brand

brand<B>(brand?): ZodBranded<ZodVoid, B>

Type parameters

NameType
Bextends string | number | symbol

Parameters

NameType
brand?B

Returns

ZodBranded<ZodVoid, B>

Inherited from

ZodType.brand


catch

catch(def): ZodCatch<ZodVoid>

Parameters

NameType
defvoid

Returns

ZodCatch<ZodVoid>

Inherited from

ZodType.catch

catch(def): ZodCatch<ZodVoid>

Parameters

NameType
def(ctx: { error: ZodError<any> ; input: void }) => void

Returns

ZodCatch<ZodVoid>

Inherited from

ZodType.catch


default

default(def): ZodDefault<ZodVoid>

Parameters

NameType
defvoid

Returns

ZodDefault<ZodVoid>

Inherited from

ZodType.default

default(def): ZodDefault<ZodVoid>

Parameters

NameType
def() => void

Returns

ZodDefault<ZodVoid>

Inherited from

ZodType.default


describe

describe(description): this

Parameters

NameType
descriptionstring

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

Returns

ZodNullable<ZodVoid>

Inherited from

ZodType.nullable


nullish

nullish(): ZodOptional<ZodNullable<ZodVoid>>

Returns

ZodOptional<ZodNullable<ZodVoid>>

Inherited from

ZodType.nullish


optional

optional(): ZodOptional<ZodVoid>

Returns

ZodOptional<ZodVoid>

Inherited from

ZodType.optional


or

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

Type parameters

NameType
Textends ZodTypeAny

Parameters

NameType
optionT

Returns

ZodUnion<[ZodVoid, T]>

Inherited from

ZodType.or


parse

parse(data, params?): void

Parameters

NameType
dataunknown
params?InexactPartial<ParseParams>

Returns

void

Inherited from

ZodType.parse


parseAsync

parseAsync(data, params?): Promise<void>

Parameters

NameType
dataunknown
params?InexactPartial<ParseParams>

Returns

Promise<void>

Inherited from

ZodType.parseAsync


pipe

pipe<T>(target): ZodPipeline<ZodVoid, T>

Type parameters

NameType
Textends ZodTypeAny

Parameters

NameType
targetT

Returns

ZodPipeline<ZodVoid, T>

Inherited from

ZodType.pipe


promise

promise(): ZodPromise<ZodVoid>

Returns

ZodPromise<ZodVoid>

Inherited from

ZodType.promise


readonly

readonly(): ZodReadonly<ZodVoid>

Returns

ZodReadonly<ZodVoid>

Inherited from

ZodType.readonly


refine

refine<RefinedOutput>(check, message?): ZodEffects<ZodVoid, RefinedOutput, void>

Type parameters

NameType
RefinedOutputextends void

Parameters

NameType
check(arg: void) => arg is RefinedOutput
message?string | Partial<Omit<ZodCustomIssue, "code">> | (arg: void) => Partial<Omit<ZodCustomIssue, "code">>

Returns

ZodEffects<ZodVoid, RefinedOutput, void>

Inherited from

ZodType.refine

refine(check, message?): ZodEffects<ZodVoid, void, void>

Parameters

NameType
check(arg: void) => unknown
message?string | Partial<Omit<ZodCustomIssue, "code">> | (arg: void) => Partial<Omit<ZodCustomIssue, "code">>

Returns

ZodEffects<ZodVoid, void, void>

Inherited from

ZodType.refine


refinement

refinement<RefinedOutput>(check, refinementData): ZodEffects<ZodVoid, RefinedOutput, void>

Type parameters

NameType
RefinedOutputextends void

Parameters

NameType
check(arg: void) => arg is RefinedOutput
refinementDataIssueData | (arg: void, ctx: RefinementCtx) => IssueData

Returns

ZodEffects<ZodVoid, RefinedOutput, void>

Inherited from

ZodType.refinement

refinement(check, refinementData): ZodEffects<ZodVoid, void, void>

Parameters

NameType
check(arg: void) => boolean
refinementDataIssueData | (arg: void, ctx: RefinementCtx) => IssueData

Returns

ZodEffects<ZodVoid, void, void>

Inherited from

ZodType.refinement


safeParse

safeParse(data, params?): SafeParseReturnType<void, void>

Parameters

NameType
dataunknown
params?InexactPartial<ParseParams>

Returns

SafeParseReturnType<void, void>

Inherited from

ZodType.safeParse


safeParseAsync

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

Parameters

NameType
dataunknown
params?InexactPartial<ParseParams>

Returns

Promise<SafeParseReturnType<void, void>>

Inherited from

ZodType.safeParseAsync


superRefine

superRefine<RefinedOutput>(refinement): ZodEffects<ZodVoid, RefinedOutput, void>

Type parameters

NameType
RefinedOutputextends void

Parameters

NameType
refinement(arg: void, ctx: RefinementCtx) => arg is RefinedOutput

Returns

ZodEffects<ZodVoid, RefinedOutput, void>

Inherited from

ZodType.superRefine

superRefine(refinement): ZodEffects<ZodVoid, void, void>

Parameters

NameType
refinement(arg: void, ctx: RefinementCtx) => void

Returns

ZodEffects<ZodVoid, void, void>

Inherited from

ZodType.superRefine

superRefine(refinement): ZodEffects<ZodVoid, void, void>

Parameters

NameType
refinement(arg: void, ctx: RefinementCtx) => Promise<void>

Returns

ZodEffects<ZodVoid, void, void>

Inherited from

ZodType.superRefine


transform

transform<NewOut>(transform): ZodEffects<ZodVoid, NewOut, void>

Type parameters

Name
NewOut

Parameters

NameType
transform(arg: void, ctx: RefinementCtx) => NewOut | Promise<NewOut>

Returns

ZodEffects<ZodVoid, NewOut, void>

Inherited from

ZodType.transform


~validate

~validate(data): Result<void> | Promise<Result<void>>

Parameters

NameType
dataunknown

Returns

Result<void> | Promise<Result<void>>

Inherited from

ZodType.~validate