Class ZodNumber

Hierarchy (View Summary)

Zod.z.ZodType<number, Zod.z.ZodNumberDef>
- ZodNumber

Constructors

constructor

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

Properties

`Readonly`_def

_def: Zod.z.ZodNumberDef

`Readonly`_input

_input: number

`Readonly`_output

_output: number

`Readonly`_type

_type: number

max

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

min

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

spa

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

Alias of safeParseAsync

step

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

`Static`create

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

Accessors

description

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

isFinite

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

isInt

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

maxValue

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

minValue

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

Methods

_addCheck

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

_getOrReturnCtx

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

_getType

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

_parse

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

_parseAsync

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

_parseSync

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

_processInputParams

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

_refinement

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

and

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

array

array(): Zod.z.ZodArray<Zod.z.ZodNumber, "many">
Returns Zod.z.ZodArray<Zod.z.ZodNumber, "many">
Inherited from ZodType.array
- Defined in node_modules/zod/lib/types.d.ts:77

brand

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

catch

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

default

default(def: number): Zod.z.ZodDefault<Zod.z.ZodNumber>
Parameters
- def: number
Returns Zod.z.ZodDefault<Zod.z.ZodNumber>
Inherited from ZodType.default
- Defined in node_modules/zod/lib/types.d.ts:82
default(def: () => number): Zod.z.ZodDefault<Zod.z.ZodNumber>
Parameters
- def: () => number
Returns Zod.z.ZodDefault<Zod.z.ZodNumber>
Inherited from ZodType.default
- Defined in 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/zod/lib/types.d.ts:90

finite

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

gt

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

gte

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

int

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

isNullable

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

isOptional

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

lt

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

lte

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

multipleOf

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

negative

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

nonnegative

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

nonpositive

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

nullable

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

nullish

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

optional

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

or

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

parse

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

parseAsync

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

pipe

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

positive

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

promise

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

readonly

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

refine

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

refinement

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

safe

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

safeParse

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

safeParseAsync

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

superRefine

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

transform

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

Class ZodNumber

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Zod.z.ZodNumber

Properties

Readonly_def

Readonly_input

Readonly_output

Readonly_type

max

min

spa

step

Staticcreate

Accessors

description

Returns undefined | string

isFinite

Returns boolean

isInt

Returns boolean

maxValue

Returns null | number

minValue

Returns null | number

Methods

_addCheck

Parameters

Returns Zod.z.ZodNumber

_getOrReturnCtx

Parameters

Returns Zod.z.ParseContext

_getType

Parameters

Returns string

_parse

Parameters

Returns Zod.z.ParseReturnType<number>

_parseAsync

Parameters

Returns Zod.z.AsyncParseReturnType<number>

_parseSync

Parameters

Returns Zod.z.SyncParseReturnType<number>

_processInputParams

Parameters

Returns { ctx: Zod.z.ParseContext; status: Zod.z.ParseStatus }

_refinement

Parameters

Returns Zod.z.ZodEffects<Zod.z.ZodNumber, number, number>

and

Type Parameters

Parameters

Returns Zod.z.ZodIntersection<Zod.z.ZodNumber, T>

array

Returns Zod.z.ZodArray<Zod.z.ZodNumber, "many">

brand

Type Parameters

Parameters

Returns Zod.z.ZodBranded<Zod.z.ZodNumber, B>

catch

Parameters

Returns Zod.z.ZodCatch<Zod.z.ZodNumber>

Parameters

Returns Zod.z.ZodCatch<Zod.z.ZodNumber>

default

Parameters

Returns Zod.z.ZodDefault<Zod.z.ZodNumber>

Parameters

Returns Zod.z.ZodDefault<Zod.z.ZodNumber>

describe

Parameters

Returns this

`Readonly`_def

`Readonly`_input

`Readonly`_output

`Readonly`_type

`Static`create