title: Core.z. Zod Number

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

Class: ZodNumber

Core.z.ZodNumber

Hierarchy

ZodType<number, ZodNumberDef, number>

↳ ZodNumber

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

• new ZodNumber(def): ZodNumber

Parameters

Name	Type
`def`	`ZodNumberDef`

Returns

ZodNumber

Inherited from

ZodType.constructor

Properties

_def

• Readonly _def: ZodNumberDef

Inherited from

ZodType._def

_input

• Readonly _input: number

Inherited from

ZodType._input

_output

• Readonly _output: number

Inherited from

ZodType._output

_type

• Readonly _type: number

Inherited from

ZodType._type

create

▪ Static create: (params?: { description?: string ; errorMap?: ZodErrorMap ; invalid_type_error?: string ; message?: string ; required_error?: string } & { coerce?: boolean }) => ZodNumber

Type declaration

▸ (params?): ZodNumber

Parameters

Name	Type
`params?`	{ `description?`: `string` ; `errorMap?`: `ZodErrorMap` ; `invalid_type_error?`: `string` ; `message?`: `string` ; `required_error?`: `string` } & { `coerce?`: `boolean` }

Returns

ZodNumber

max

• max: (value: number, message?: ErrMessage) => ZodNumber

Type declaration

▸ (value, message?): ZodNumber

Parameters

Name	Type
`value`	`number`
`message?`	`ErrMessage`

Returns

ZodNumber

min

• min: (value: number, message?: ErrMessage) => ZodNumber

Type declaration

▸ (value, message?): ZodNumber

Parameters

Name	Type
`value`	`number`
`message?`	`ErrMessage`

Returns

ZodNumber

spa

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

Alias of safeParseAsync

Type declaration

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

Parameters

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

Returns

Promise<SafeParseReturnType<number, number>>

Inherited from

ZodType.spa

step

• step: (value: number, message?: ErrMessage) => ZodNumber

Type declaration

▸ (value, message?): ZodNumber

Parameters

Name	Type
`value`	`number`
`message?`	`ErrMessage`

Returns

ZodNumber

~standard

• ~standard: Props<number, number>

Inherited from

ZodType.~standard

Accessors

description

• get description(): undefined | string

Returns

undefined | string

Inherited from

ZodType.description

isFinite

• get isFinite(): boolean

Returns

boolean

isInt

• get isInt(): boolean

Returns

boolean

maxValue

• get maxValue(): null | number

Returns

null | number

minValue

• get minValue(): null | number

Returns

null | number

Methods

_addCheck

▸ _addCheck(check): ZodNumber

Parameters

Name	Type
`check`	`ZodNumberCheck`

Returns

ZodNumber

_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<number>

Parameters

Name	Type
`input`	`ParseInput`

Returns

ParseReturnType<number>

Overrides

ZodType._parse

_parseAsync

▸ _parseAsync(input): AsyncParseReturnType<number>

Parameters

Name	Type
`input`	`ParseInput`

Returns

AsyncParseReturnType<number>

Inherited from

ZodType._parseAsync

_parseSync

▸ _parseSync(input): SyncParseReturnType<number>

Parameters

Name	Type
`input`	`ParseInput`

Returns

SyncParseReturnType<number>

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<ZodNumber, number, number>

Parameters

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

Returns

ZodEffects<ZodNumber, number, number>

Inherited from

ZodType._refinement

and

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

Type parameters

Name	Type
`T`	extends `ZodTypeAny`

Parameters

Name	Type
`incoming`	`T`

Returns

ZodIntersection<ZodNumber, T>

Inherited from

ZodType.and

array

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

Returns

ZodArray<ZodNumber, "many">

Inherited from

ZodType.array

brand

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

Type parameters

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

Parameters

Name	Type
`brand?`	`B`

Returns

ZodBranded<ZodNumber, B>

Inherited from

ZodType.brand

catch

▸ catch(def): ZodCatch<ZodNumber>

Parameters

Name	Type
`def`	`number`

Returns

ZodCatch<ZodNumber>

Inherited from

ZodType.catch

▸ catch(def): ZodCatch<ZodNumber>

Parameters

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

Returns

ZodCatch<ZodNumber>

Inherited from

ZodType.catch

default

▸ default(def): ZodDefault<ZodNumber>

Parameters

Name	Type
`def`	`number`

Returns

ZodDefault<ZodNumber>

Inherited from

ZodType.default

▸ default(def): ZodDefault<ZodNumber>

Parameters

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

Returns

ZodDefault<ZodNumber>

Inherited from

ZodType.default

describe

▸ describe(description): this

Parameters

Name	Type
`description`	`string`

Returns

this

Inherited from

ZodType.describe

finite

▸ finite(message?): ZodNumber

Parameters

Name	Type
`message?`	`ErrMessage`

Returns

ZodNumber

gt

▸ gt(value, message?): ZodNumber

Parameters

Name	Type
`value`	`number`
`message?`	`ErrMessage`

Returns

ZodNumber

gte

▸ gte(value, message?): ZodNumber

Parameters

Name	Type
`value`	`number`
`message?`	`ErrMessage`

Returns

ZodNumber

int

▸ int(message?): ZodNumber

Parameters

Name	Type
`message?`	`ErrMessage`

Returns

ZodNumber

isNullable

▸ isNullable(): boolean

Returns

boolean

Inherited from

ZodType.isNullable

isOptional

▸ isOptional(): boolean

Returns

boolean

Inherited from

ZodType.isOptional

lt

▸ lt(value, message?): ZodNumber

Parameters

Name	Type
`value`	`number`
`message?`	`ErrMessage`

Returns

ZodNumber

lte

▸ lte(value, message?): ZodNumber

Parameters

Name	Type
`value`	`number`
`message?`	`ErrMessage`

Returns

ZodNumber

multipleOf

▸ multipleOf(value, message?): ZodNumber

Parameters

Name	Type
`value`	`number`
`message?`	`ErrMessage`

Returns

ZodNumber

negative

▸ negative(message?): ZodNumber

Parameters

Name	Type
`message?`	`ErrMessage`

Returns

ZodNumber

nonnegative

▸ nonnegative(message?): ZodNumber

Parameters

Name	Type
`message?`	`ErrMessage`

Returns

ZodNumber

nonpositive

▸ nonpositive(message?): ZodNumber

Parameters

Name	Type
`message?`	`ErrMessage`

or

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

Type parameters

Name	Type
`T`	extends `ZodTypeAny`

Parameters

Name	Type
`option`	`T`

Returns

ZodUnion<[ZodNumber, T]>

Inherited from

ZodType.or

parse

▸ parse(data, params?): number

Parameters

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

Returns

number

Inherited from

ZodType.parse

parseAsync

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

Parameters

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

Returns

Promise<number>

Inherited from

ZodType.parseAsync

pipe

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

Type parameters

Name	Type
`T`	extends `ZodTypeAny`

Parameters

Name	Type
`target`	`T`

Returns

ZodPipeline<ZodNumber, T>

Inherited from

ZodType.pipe

positive

▸ positive(message?): ZodNumber

Parameters

Name	Type
`message?`	`ErrMessage`

Returns

ZodNumber

promise

▸ promise(): ZodPromise<ZodNumber>

Returns

ZodPromise<ZodNumber>

Inherited from

ZodType.promise

readonly

▸ readonly(): ZodReadonly<ZodNumber>

Returns

ZodReadonly<ZodNumber>

Inherited from

ZodType.readonly

refine

▸ refine<RefinedOutput>(check, message?): ZodEffects<ZodNumber, RefinedOutput, number>

Type parameters

Name	Type
`RefinedOutput`	extends `number`

Parameters

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

Returns

ZodEffects<ZodNumber, RefinedOutput, number>

Inherited from

ZodType.refine

▸ refine(check, message?): ZodEffects<ZodNumber, number, number>

Parameters

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

Returns

ZodEffects<ZodNumber, number, number>

Inherited from

ZodType.refine

refinement

▸ refinement<RefinedOutput>(check, refinementData): ZodEffects<ZodNumber, RefinedOutput, number>

Type parameters

Name	Type
`RefinedOutput`	extends `number`

Parameters

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

Returns

ZodEffects<ZodNumber, RefinedOutput, number>

Inherited from

ZodType.refinement

▸ refinement(check, refinementData): ZodEffects<ZodNumber, number, number>

Parameters

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

Returns

ZodEffects<ZodNumber, number, number>

Inherited from

ZodType.refinement

safe

▸ safe(message?): ZodNumber

Parameters

Name	Type
`message?`	`ErrMessage`

Returns

ZodNumber

safeParse

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

Parameters

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

Returns

SafeParseReturnType<number, number>

Inherited from

ZodType.safeParse

safeParseAsync

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

Parameters

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

Returns

Promise<SafeParseReturnType<number, number>>

Inherited from

ZodType.safeParseAsync

setLimit

▸ setLimit(kind, value, inclusive, message?): ZodNumber

Parameters

Name	Type
`kind`	`"min"` \| `"max"`
`value`	`number`
`inclusive`	`boolean`
`message?`	`string`

Returns

ZodNumber

superRefine

▸ superRefine<RefinedOutput>(refinement): ZodEffects<ZodNumber, RefinedOutput, number>

Type parameters

Name	Type
`RefinedOutput`	extends `number`

Parameters

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

Returns

ZodEffects<ZodNumber, RefinedOutput, number>

Inherited from

ZodType.superRefine

▸ superRefine(refinement): ZodEffects<ZodNumber, number, number>

Parameters

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

Returns

ZodEffects<ZodNumber, number, number>

Inherited from

ZodType.superRefine

▸ superRefine(refinement): ZodEffects<ZodNumber, number, number>

Parameters

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

Returns

ZodEffects<ZodNumber, number, number>

Inherited from

ZodType.superRefine

transform

▸ transform<NewOut>(transform): ZodEffects<ZodNumber, NewOut, number>

Type parameters

Name
`NewOut`

Parameters

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

Returns

ZodEffects<ZodNumber, NewOut, number>

Inherited from

ZodType.transform

~validate

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

Parameters

Name	Type
`data`	`unknown`

Returns

Result<number> | Promise<Result<number>>

Inherited from

ZodType.~validate

z.ZodNullable z.ZodObject

title: Core.z. Zod Number

Class: ZodNumber

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

max

Type declaration

Parameters

Returns

min

Type declaration

Parameters

Returns

spa

Type declaration

Parameters

Returns

Inherited from

step

Type declaration

Parameters

Returns

~standard

Inherited from

Accessors

description

Returns

Inherited from

isFinite

Returns

isInt

Returns

maxValue

Returns

minValue

Returns

Methods

_addCheck

Parameters

Returns

_getOrReturnCtx

Parameters

Returns

Inherited from

_getType

Parameters

Returns

Inherited from

_parse

Parameters

Returns

Overrides

_parseAsync

Parameters

Returns

Inherited from

_parseSync

Parameters

Returns