Class ZodNumber

Hierarchy (View Summary)

ZodType<number, ZodNumberDef>
- ZodNumber

Constructors

constructor

new ZodNumber(def: ZodNumberDef): ZodNumber
Parameters
- def: ZodNumberDef
Returns ZodNumber
Inherited from ZodType.constructor
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:73

Properties

`Readonly`_def

_def: ZodNumberDef

`Readonly`_input

_input: number

`Readonly`_output

_output: number

`Readonly`_type

_type: number

max

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

min

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

spa

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

Alias of safeParseAsync

step

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

`Static`create

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

Accessors

description

get description(): string | undefined
Returns string | undefined
Inherited from ZodType.description
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:49

isFinite

get isFinite(): boolean
Returns boolean
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:285

isInt

get isInt(): boolean
Returns boolean
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:284

maxValue

get maxValue(): number | null
Returns number | null
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:283

minValue

get minValue(): number | null
Returns number | null
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:282

Methods

_addCheck

_addCheck(check: ZodNumberCheck): ZodNumber
Parameters
- check: ZodNumberCheck
Returns ZodNumber
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:272

_getOrReturnCtx

_getOrReturnCtx(input: ParseInput, ctx?: ParseContext): ParseContext
Parameters
- input: ParseInput
- Optionalctx: ParseContext
Returns ParseContext
Inherited from ZodType._getOrReturnCtx
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:52

_getType

_getType(input: ParseInput): string
Parameters
- input: ParseInput
Returns string
Inherited from ZodType._getType
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:51

_parse

_parse(input: ParseInput): ParseReturnType<number>
Parameters
- input: ParseInput
Returns ParseReturnType<number>
Overrides ZodType._parse
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:256

_parseAsync

_parseAsync(input: ParseInput): AsyncParseReturnType<number>
Parameters
- input: ParseInput
Returns AsyncParseReturnType<number>
Inherited from ZodType._parseAsync
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:58

_parseSync

_parseSync(input: ParseInput): SyncParseReturnType<number>
Parameters
- input: ParseInput
Returns SyncParseReturnType<number>
Inherited from ZodType._parseSync
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:57

_processInputParams

_processInputParams(
input: ParseInput,
): { ctx: ParseContext; status: ParseStatus }
Parameters
- input: ParseInput
Returns { ctx: ParseContext; status: ParseStatus }
Inherited from ZodType._processInputParams
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:53

_refinement

_refinement(
refinement: (arg: number, ctx: RefinementCtx) => any,
): ZodEffects<ZodNumber, number, number>
Parameters
- refinement: (arg: number, ctx: RefinementCtx) => any
Returns ZodEffects<ZodNumber, number, number>
Inherited from ZodType._refinement
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:69

and

and<T extends ZodTypeAny>(incoming: T): ZodIntersection<ZodNumber, T>
Type Parameters
- T extends ZodTypeAny
Parameters
- incoming: T
Returns ZodIntersection<ZodNumber, T>
Inherited from ZodType.and
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:80

array

array(): ZodArray<ZodNumber>
Returns ZodArray<ZodNumber>
Inherited from ZodType.array
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:77

brand

brand<B extends string | number | symbol>(brand?: B): ZodBranded<ZodNumber, B>
Type Parameters
- B extends string | number | symbol
Parameters
- Optionalbrand: B
Returns ZodBranded<ZodNumber, B>
Inherited from ZodType.brand
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:84

catch

catch(def: number): ZodCatch<ZodNumber>
Parameters
- def: number
Returns ZodCatch<ZodNumber>
Inherited from ZodType.catch
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:85
catch(
def: (ctx: { error: ZodError; input: number }) => number,
): ZodCatch<ZodNumber>
Parameters
- def: (ctx: { error: ZodError; input: number }) => number
Returns ZodCatch<ZodNumber>
Inherited from ZodType.catch
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:86

default

default(def: number): ZodDefault<ZodNumber>
Parameters
- def: number
Returns ZodDefault<ZodNumber>
Inherited from ZodType.default
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:82
default(def: () => number): ZodDefault<ZodNumber>
Parameters
- def: () => number
Returns ZodDefault<ZodNumber>
Inherited from ZodType.default
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:83

describe

describe(description: string): this
Parameters
- description: string
Returns this
Inherited from ZodType.describe
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:90

finite

finite(message?: ErrMessage): ZodNumber
Parameters
- Optionalmessage: ErrMessage
Returns ZodNumber
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:280

gt

gt(value: number, message?: ErrMessage): ZodNumber
Parameters
- value: number
- Optionalmessage: ErrMessage
Returns ZodNumber
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:267

gte

gte(value: number, message?: ErrMessage): ZodNumber
Parameters
- value: number
- Optionalmessage: ErrMessage
Returns ZodNumber
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:265

int

int(message?: ErrMessage): ZodNumber
Parameters
- Optionalmessage: ErrMessage
Returns ZodNumber
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:273

isNullable

isNullable(): boolean
Returns boolean
Inherited from ZodType.isNullable
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:94

isOptional

isOptional(): boolean
Returns boolean
Inherited from ZodType.isOptional
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:93

lt

lt(value: number, message?: ErrMessage): ZodNumber
Parameters
- value: number
- Optionalmessage: ErrMessage
Returns ZodNumber
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:270

lte

lte(value: number, message?: ErrMessage): ZodNumber
Parameters
- value: number
- Optionalmessage: ErrMessage
Returns ZodNumber
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:268

multipleOf

multipleOf(value: number, message?: ErrMessage): ZodNumber
Parameters
- value: number
- Optionalmessage: ErrMessage
Returns ZodNumber
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:278

negative

negative(message?: ErrMessage): ZodNumber
Parameters
- Optionalmessage: ErrMessage
Returns ZodNumber
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:275

nonnegative

nonnegative(message?: ErrMessage): ZodNumber
Parameters
- Optionalmessage: ErrMessage
Returns ZodNumber
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:277

nonpositive

nonpositive(message?: ErrMessage): ZodNumber
Parameters
- Optionalmessage: ErrMessage
Returns ZodNumber
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:276

nullable

nullable(): ZodNullable<ZodNumber>
Returns ZodNullable<ZodNumber>
Inherited from ZodType.nullable
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:75

nullish

nullish(): ZodOptional<ZodNullable<ZodNumber>>
Returns ZodOptional<ZodNullable<ZodNumber>>
Inherited from ZodType.nullish
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:76

optional

optional(): ZodOptional<ZodNumber>
Returns ZodOptional<ZodNumber>
Inherited from ZodType.optional
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:74

or

or<T extends ZodTypeAny>(option: T): ZodUnion<[ZodNumber, T]>
Type Parameters
- T extends ZodTypeAny
Parameters
- option: T
Returns ZodUnion<[ZodNumber, T]>
Inherited from ZodType.or
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:79

parse

parse(data: unknown, params?: Partial<ParseParams>): number
Parameters
- data: unknown
- Optionalparams: Partial<ParseParams>
Returns number
Inherited from ZodType.parse
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:59

parseAsync

parseAsync(data: unknown, params?: Partial<ParseParams>): Promise<number>
Parameters
- data: unknown
- Optionalparams: Partial<ParseParams>
Returns Promise<number>
Inherited from ZodType.parseAsync
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:61

pipe

pipe<T extends ZodTypeAny>(target: T): ZodPipeline<ZodNumber, T>
Type Parameters
- T extends ZodTypeAny
Parameters
- target: T
Returns ZodPipeline<ZodNumber, T>
Inherited from ZodType.pipe
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:91

positive

positive(message?: ErrMessage): ZodNumber
Parameters
- Optionalmessage: ErrMessage
Returns ZodNumber
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:274

promise

promise(): ZodPromise<ZodNumber>
Returns ZodPromise<ZodNumber>
Inherited from ZodType.promise
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:78

readonly

readonly(): ZodReadonly<ZodNumber>
Returns ZodReadonly<ZodNumber>
Inherited from ZodType.readonly
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:92

refine

refine<RefinedOutput extends number>(
    check: (arg: number) => arg is RefinedOutput,
    message?:
        | string
        | Partial<Omit<ZodCustomIssue, "code">>
        | ((arg: number) => CustomErrorParams),
): ZodEffects<ZodNumber, RefinedOutput, number>
Type Parameters
- RefinedOutput extends number
Parameters
- check: (arg: number) => arg is RefinedOutput
- Optionalmessage:
      | string
      | Partial<Omit<ZodCustomIssue, "code">>
      | ((arg: number) => CustomErrorParams)
Returns ZodEffects<ZodNumber, RefinedOutput, number>
Inherited from ZodType.refine
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:65
refine(
    check: (arg: number) => unknown,
    message?:
        | string
        | Partial<Omit<ZodCustomIssue, "code">>
        | ((arg: number) => CustomErrorParams),
): ZodEffects<ZodNumber, number, number>
Parameters
- check: (arg: number) => unknown
- Optionalmessage:
      | string
      | Partial<Omit<ZodCustomIssue, "code">>
      | ((arg: number) => CustomErrorParams)
Returns ZodEffects<ZodNumber, number, number>
Inherited from ZodType.refine
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:66

refinement<RefinedOutput extends number>(
    check: (arg: number) => arg is RefinedOutput,
    refinementData:
        | IssueData
        | ((arg: number, ctx: RefinementCtx) => IssueData),
): ZodEffects<ZodNumber, RefinedOutput, number>
Type Parameters
- RefinedOutput extends number
Parameters
- check: (arg: number) => arg is RefinedOutput
- refinementData: IssueData | ((arg: number, ctx: RefinementCtx) => IssueData)
Returns ZodEffects<ZodNumber, RefinedOutput, number>
Inherited from ZodType.refinement
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:67
refinement(
    check: (arg: number) => boolean,
    refinementData:
        | IssueData
        | ((arg: number, ctx: RefinementCtx) => IssueData),
): ZodEffects<ZodNumber, number, number>
Parameters
- check: (arg: number) => boolean
- refinementData: IssueData | ((arg: number, ctx: RefinementCtx) => IssueData)
Returns ZodEffects<ZodNumber, number, number>
Inherited from ZodType.refinement
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:68

safe

safe(message?: ErrMessage): ZodNumber
Parameters
- Optionalmessage: ErrMessage
Returns ZodNumber
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:281

safeParse

safeParse(
data: unknown,
params?: Partial<ParseParams>,
): SafeParseReturnType<number, number>
Parameters
- data: unknown
- Optionalparams: Partial<ParseParams>
Returns SafeParseReturnType<number, number>
Inherited from ZodType.safeParse
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:60

safeParseAsync

safeParseAsync(
data: unknown,
params?: Partial<ParseParams>,
): Promise<SafeParseReturnType<number, number>>
Parameters
- data: unknown
- Optionalparams: Partial<ParseParams>
Returns Promise<SafeParseReturnType<number, number>>
Inherited from ZodType.safeParseAsync
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:62

`Protected`setLimit

setLimit(
    kind: "min" | "max",
    value: number,
    inclusive: boolean,
    message?: string,
): ZodNumber
Parameters
- kind: "min" | "max"
- value: number
- inclusive: boolean
- Optionalmessage: string
Returns ZodNumber
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:271

superRefine

superRefine<RefinedOutput extends number>(
refinement: (arg: number, ctx: RefinementCtx) => arg is RefinedOutput,
): ZodEffects<ZodNumber, RefinedOutput, number>
Type Parameters
- RefinedOutput extends number
Parameters
- refinement: (arg: number, ctx: RefinementCtx) => arg is RefinedOutput
Returns ZodEffects<ZodNumber, RefinedOutput, number>
Inherited from ZodType.superRefine
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:70
superRefine(
refinement: (arg: number, ctx: RefinementCtx) => void,
): ZodEffects<ZodNumber, number, number>
Parameters
- refinement: (arg: number, ctx: RefinementCtx) => void
Returns ZodEffects<ZodNumber, number, number>
Inherited from ZodType.superRefine
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:71
superRefine(
refinement: (arg: number, ctx: RefinementCtx) => Promise<void>,
): ZodEffects<ZodNumber, number, number>
Parameters
- refinement: (arg: number, ctx: RefinementCtx) => Promise<void>
Returns ZodEffects<ZodNumber, number, number>
Inherited from ZodType.superRefine
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:72

transform

transform<NewOut>(
transform: (arg: number, ctx: RefinementCtx) => NewOut | Promise<NewOut>,
): ZodEffects<ZodNumber, NewOut>
Type Parameters
- NewOut
Parameters
- transform: (arg: number, ctx: RefinementCtx) => NewOut | Promise<NewOut>
Returns ZodEffects<ZodNumber, NewOut>
Inherited from ZodType.transform
- Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:81

Class ZodNumber

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ZodNumber

Properties

Readonly_def

Readonly_input

Readonly_output

Readonly_type

max

min

spa

step

Staticcreate

Accessors

description

Returns string | undefined

isFinite

Returns boolean

isInt

Returns boolean

maxValue

Returns number | null

minValue

Returns number | null

Methods

_addCheck

Parameters

Returns ZodNumber

_getOrReturnCtx

Parameters

Returns ParseContext

_getType

Parameters

Returns string

_parse

Parameters

Returns ParseReturnType<number>

_parseAsync

Parameters

Returns AsyncParseReturnType<number>

_parseSync

Parameters

Returns SyncParseReturnType<number>

_processInputParams

Parameters

Returns { ctx: ParseContext; status: ParseStatus }

_refinement

Parameters

Returns ZodEffects<ZodNumber, number, number>

and

Type Parameters

Parameters

Returns ZodIntersection<ZodNumber, T>

array

Returns ZodArray<ZodNumber>

brand

Type Parameters

Parameters

Returns ZodBranded<ZodNumber, B>

catch

Parameters

Returns ZodCatch<ZodNumber>

Parameters

Returns ZodCatch<ZodNumber>

default

Parameters

Returns ZodDefault<ZodNumber>

Parameters

Returns ZodDefault<ZodNumber>

describe

Parameters

Returns this

`Readonly`_def

`Readonly`_input

`Readonly`_output

`Readonly`_type

`Static`create