Interface ZodCoercedNumber<T>

interface ZodCoercedNumber<T = unknown> {
    def: $ZodNumberDef;
    type: "number";
    _def: $ZodNumberDef;
    _output: number;
    _input: T;
    check(...checks: ($ZodCheck<number> | CheckFn<number>)[]): this;
    clone(def?: $ZodNumberDef, params?: { parent: boolean }): this;
    register<
        R extends
            $ZodRegistry<
                MetadataType,
                $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>,
            >,
    >(
        registry: R,
        ...meta: ZodCoercedNumber<T> extends R["_schema"]
            ? undefined extends R["_meta"]
                ? [$replace<R["_meta"], R["_schema"] & ZodCoercedNumber<T>>?]
                : [$replace<R["_meta"], R["_schema"] & ZodCoercedNumber<T>>]
            : ["Incompatible schema"],
    ): this;
    brand<T extends PropertyKey = PropertyKey>(
        value?: T,
    ): PropertyKey extends T
        ? ZodCoercedNumber<T>
        : $ZodBranded<ZodCoercedNumber<T>, T>;
    parse(data: unknown, params?: ParseContext<$ZodIssue>): number;
    safeParse(
        data: unknown,
        params?: ParseContext<$ZodIssue>,
    ): ZodSafeParseResult<number>;
    parseAsync(
        data: unknown,
        params?: ParseContext<$ZodIssue>,
    ): Promise<number>;
    safeParseAsync(
        data: unknown,
        params?: ParseContext<$ZodIssue>,
    ): Promise<ZodSafeParseResult<number>>;
    spa: (
        data: unknown,
        params?: ParseContext<$ZodIssue>,
    ) => Promise<ZodSafeParseResult<number>>;
    encode(data: number, params?: ParseContext<$ZodIssue>): T;
    decode(data: T, params?: ParseContext<$ZodIssue>): number;
    encodeAsync(data: number, params?: ParseContext<$ZodIssue>): Promise<T>;
    decodeAsync(data: T, params?: ParseContext<$ZodIssue>): Promise<number>;
    safeEncode(
        data: number,
        params?: ParseContext<$ZodIssue>,
    ): ZodSafeParseResult<T>;
    safeDecode(
        data: T,
        params?: ParseContext<$ZodIssue>,
    ): ZodSafeParseResult<number>;
    safeEncodeAsync(
        data: number,
        params?: ParseContext<$ZodIssue>,
    ): Promise<ZodSafeParseResult<T>>;
    safeDecodeAsync(
        data: T,
        params?: ParseContext<$ZodIssue>,
    ): Promise<ZodSafeParseResult<number>>;
    refine(
        check: (arg: number) => unknown,
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<NonNullable<$ZodIssue>>;
                message?: string;
                abort?: boolean;
                when?: (payload: ParsePayload) => boolean;
                path?: PropertyKey[];
                params?: Record<string, any>;
            },
    ): this;
    superRefine(
        refinement: (
            arg: number,
            ctx: $RefinementCtx<number>,
        ) => void | Promise<void>,
    ): this;
    overwrite(fn: (x: number) => number): this;
    optional(): ZodOptional<ZodCoercedNumber<T>>;
    nonoptional(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
                message?: string;
            },
    ): ZodNonOptional<ZodCoercedNumber<T>>;
    nullable(): ZodNullable<ZodCoercedNumber<T>>;
    nullish(): ZodOptional<ZodNullable<ZodCoercedNumber<T>>>;
    default(def: number): ZodDefault<ZodCoercedNumber<T>>;
    default(def: () => number): ZodDefault<ZodCoercedNumber<T>>;
    prefault(def: () => T): ZodPrefault<ZodCoercedNumber<T>>;
    prefault(def: T): ZodPrefault<ZodCoercedNumber<T>>;
    array(): ZodArray<ZodCoercedNumber<T>>;
    or<T extends SomeType>(option: T): ZodUnion<[ZodCoercedNumber<T>, T]>;
    and<T extends SomeType>(
        incoming: T,
    ): ZodIntersection<ZodCoercedNumber<T>, T>;
    transform<NewOut>(
        transform: (
            arg: number,
            ctx: $RefinementCtx<number>,
        ) => NewOut | Promise<NewOut>,
    ): ZodPipe<ZodCoercedNumber<T>, ZodTransform<Awaited<NewOut>, number>>;
    catch(def: number): ZodCatch<ZodCoercedNumber<T>>;
    catch(def: (ctx: $ZodCatchCtx) => number): ZodCatch<ZodCoercedNumber<T>>;
    pipe<T extends $ZodType<any, number, $ZodTypeInternals<any, number>>>(
        target: $ZodType<any, number, $ZodTypeInternals<any, number>> | T,
    ): ZodPipe<ZodCoercedNumber<T>, T>;
    readonly(): ZodReadonly<ZodCoercedNumber<T>>;
    describe(description: string): this;
    description?: string;
    meta(): | undefined
    | {
        id?: string;
        title?: string;
        description?: string;
        deprecated?: boolean;
        [key: string]: unknown;
    };
    meta(
        data: {
            id?: string;
            title?: string;
            description?: string;
            deprecated?: boolean;
            [key: string]: unknown;
        },
    ): this;
    isOptional(): boolean;
    isNullable(): boolean;
    gt(
        value: number,
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
                message?: string;
                abort?: boolean;
            },
    ): this;
    gte(
        value: number,
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
                message?: string;
                abort?: boolean;
            },
    ): this;
    min(
        value: number,
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
                message?: string;
                abort?: boolean;
            },
    ): this;
    lt(
        value: number,
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
                message?: string;
                abort?: boolean;
            },
    ): this;
    lte(
        value: number,
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
                message?: string;
                abort?: boolean;
            },
    ): this;
    max(
        value: number,
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
                message?: string;
                abort?: boolean;
            },
    ): this;
    int(
        params?:
            | string
            | {
                error?: | string
                | $ZodErrorMap<
                    NonNullable<
                        | $ZodIssueInvalidType<unknown>
                        | $ZodIssueTooBig<"number">
                        | $ZodIssueTooSmall<"number">,
                    >,
                >;
                message?: string;
                abort?: boolean;
            },
    ): this;
    safe(
        params?:
            | string
            | {
                error?: | string
                | $ZodErrorMap<
                    NonNullable<
                        | $ZodIssueInvalidType<unknown>
                        | $ZodIssueTooBig<"number">
                        | $ZodIssueTooSmall<"number">,
                    >,
                >;
                message?: string;
                abort?: boolean;
            },
    ): this;
    positive(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
                message?: string;
                abort?: boolean;
            },
    ): this;
    nonnegative(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
                message?: string;
                abort?: boolean;
            },
    ): this;
    negative(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
                message?: string;
                abort?: boolean;
            },
    ): this;
    nonpositive(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
                message?: string;
                abort?: boolean;
            },
    ): this;
    multipleOf(
        value: number,
        params?:
            | string
            | {
                error?: | string
                | $ZodErrorMap<$ZodIssueNotMultipleOf<number | bigint>>;
                message?: string;
                abort?: boolean;
            },
    ): this;
    step(
        value: number,
        params?:
            | string
            | {
                error?: | string
                | $ZodErrorMap<$ZodIssueNotMultipleOf<number | bigint>>;
                message?: string;
                abort?: boolean;
            },
    ): this;
    finite(params?: unknown): this;
    minValue: null | number;
    maxValue: null | number;
    isInt: boolean;
    isFinite: boolean;
    format: null | string;
    _zod: $ZodNumberInternals;
    "~standard": $ZodStandardSchema<ZodCoercedNumber<T>>;
}

Type Parameters

T = unknown

Hierarchy (View Summary)

_ZodNumber<$ZodNumberInternals<T>>
- ZodCoercedNumber

Properties

def

def: $ZodNumberDef

type

type: "number"

_def

_def: $ZodNumberDef

Deprecated

Use .def instead.

_output

_output: number

Deprecated

Use z.output<typeof schema> instead.

_input

_input: T

Deprecated

Use z.input<typeof schema> instead.

spa

spa: (
data: unknown,
params?: ParseContext<$ZodIssue>,
) => Promise<ZodSafeParseResult<number>>

`Optional`description

description?: string

minValue

minValue: null | number

maxValue

maxValue: null | number

isInt

isInt: boolean

Deprecated

Check the format property instead.

isFinite

isFinite: boolean

Deprecated

Number schemas no longer accept infinite values, so this always returns true.

format

format: null | string

_zod

_zod: $ZodNumberInternals

~standard

"~standard": $ZodStandardSchema<ZodCoercedNumber<T>>

Methods

check

check(...checks: ($ZodCheck<number> | CheckFn<number>)[]): this
Parameters
- ...checks: ($ZodCheck<number> | CheckFn<number>)[]
Returns this
Inherited from _ZodNumber.check
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:13

clone

clone(def?: $ZodNumberDef, params?: { parent: boolean }): this
Parameters
- Optionaldef: $ZodNumberDef
- Optionalparams: { parent: boolean }
Returns this
Inherited from _ZodNumber.clone
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:14

register

register<
    R extends
        $ZodRegistry<
            MetadataType,
            $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>,
        >,
>(
    registry: R,
    ...meta: ZodCoercedNumber<T> extends R["_schema"]
        ? undefined extends R["_meta"]
            ? [$replace<R["_meta"], R["_schema"] & ZodCoercedNumber<T>>?]
            : [$replace<R["_meta"], R["_schema"] & ZodCoercedNumber<T>>]
        : ["Incompatible schema"],
): this
Type Parameters
- R extends $ZodRegistry<
  MetadataType,
  $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>,
  >
Parameters
- registry: R
- ...meta: ZodCoercedNumber<T> extends R["_schema"]
      ? undefined extends R["_meta"]
          ? [$replace<R["_meta"], R["_schema"] & ZodCoercedNumber<T>>?]
          : [$replace<R["_meta"], R["_schema"] & ZodCoercedNumber<T>>]
      : ["Incompatible schema"]
Returns this
Inherited from _ZodNumber.register
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:17

brand

brand<T extends PropertyKey = PropertyKey>(
    value?: T,
): PropertyKey extends T
    ? ZodCoercedNumber<T>
    : $ZodBranded<ZodCoercedNumber<T>, T>
Type Parameters
- T extends PropertyKey = PropertyKey
Parameters
- Optionalvalue: T
Returns PropertyKey extends T
? ZodCoercedNumber<T>
: $ZodBranded<ZodCoercedNumber<T>, T>
Inherited from _ZodNumber.brand
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:18

parse

parse(data: unknown, params?: ParseContext<$ZodIssue>): number
Parameters
- data: unknown
- Optionalparams: ParseContext<$ZodIssue>
Returns number
Inherited from _ZodNumber.parse
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:19

safeParse

safeParse(
data: unknown,
params?: ParseContext<$ZodIssue>,
): ZodSafeParseResult<number>
Parameters
- data: unknown
- Optionalparams: ParseContext<$ZodIssue>
Returns ZodSafeParseResult<number>
Inherited from _ZodNumber.safeParse
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:20

parseAsync

parseAsync(data: unknown, params?: ParseContext<$ZodIssue>): Promise<number>
Parameters
- data: unknown
- Optionalparams: ParseContext<$ZodIssue>
Returns Promise<number>
Inherited from _ZodNumber.parseAsync
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:21

safeParseAsync

safeParseAsync(
data: unknown,
params?: ParseContext<$ZodIssue>,
): Promise<ZodSafeParseResult<number>>
Parameters
- data: unknown
- Optionalparams: ParseContext<$ZodIssue>
Returns Promise<ZodSafeParseResult<number>>
Inherited from _ZodNumber.safeParseAsync
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:22

encode

encode(data: number, params?: ParseContext<$ZodIssue>): T
Parameters
- data: number
- Optionalparams: ParseContext<$ZodIssue>
Returns T
Inherited from _ZodNumber.encode
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:24

decode

decode(data: T, params?: ParseContext<$ZodIssue>): number
Parameters
- data: T
- Optionalparams: ParseContext<$ZodIssue>
Returns number
Inherited from _ZodNumber.decode
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:25

encodeAsync

encodeAsync(data: number, params?: ParseContext<$ZodIssue>): Promise<T>
Parameters
- data: number
- Optionalparams: ParseContext<$ZodIssue>
Returns Promise<T>
Inherited from _ZodNumber.encodeAsync
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:26

decodeAsync

decodeAsync(data: T, params?: ParseContext<$ZodIssue>): Promise<number>
Parameters
- data: T
- Optionalparams: ParseContext<$ZodIssue>
Returns Promise<number>
Inherited from _ZodNumber.decodeAsync
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:27

safeEncode

safeEncode(
data: number,
params?: ParseContext<$ZodIssue>,
): ZodSafeParseResult<T>
Parameters
- data: number
- Optionalparams: ParseContext<$ZodIssue>
Returns ZodSafeParseResult<T>
Inherited from _ZodNumber.safeEncode
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:28

safeDecode

safeDecode(
data: T,
params?: ParseContext<$ZodIssue>,
): ZodSafeParseResult<number>
Parameters
- data: T
- Optionalparams: ParseContext<$ZodIssue>
Returns ZodSafeParseResult<number>
Inherited from _ZodNumber.safeDecode
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:29

safeEncodeAsync

safeEncodeAsync(
data: number,
params?: ParseContext<$ZodIssue>,
): Promise<ZodSafeParseResult<T>>
Parameters
- data: number
- Optionalparams: ParseContext<$ZodIssue>
Returns Promise<ZodSafeParseResult<T>>
Inherited from _ZodNumber.safeEncodeAsync
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:30

safeDecodeAsync

safeDecodeAsync(
data: T,
params?: ParseContext<$ZodIssue>,
): Promise<ZodSafeParseResult<number>>
Parameters
- data: T
- Optionalparams: ParseContext<$ZodIssue>
Returns Promise<ZodSafeParseResult<number>>
Inherited from _ZodNumber.safeDecodeAsync
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:31

refine

refine(
    check: (arg: number) => unknown,
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<NonNullable<$ZodIssue>>;
            message?: string;
            abort?: boolean;
            when?: (payload: ParsePayload) => boolean;
            path?: PropertyKey[];
            params?: Record<string, any>;
        },
): this
Parameters
- check: (arg: number) => unknown
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<NonNullable<$ZodIssue>>;
          message?: string;
          abort?: boolean;
          when?: (payload: ParsePayload) => boolean;
          path?: PropertyKey[];
          params?: Record<string, any>;
      }
  - string
  - {
        error?: string | $ZodErrorMap<NonNullable<$ZodIssue>>;
        message?: string;
        abort?: boolean;
        when?: (payload: ParsePayload) => boolean;
        path?: PropertyKey[];
        params?: Record<string, any>;
    }
    Optionalerror?: string | $ZodErrorMap<NonNullable<$ZodIssue>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalwhen?: (payload: ParsePayload) => boolean
    If provided, this check will only be executed if the function returns true. Defaults to payload => z.util.isAborted(payload).
    
    Optionalpath?: PropertyKey[]
    Optionalparams?: Record<string, any>
Returns this
Inherited from _ZodNumber.refine
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:32

superRefine

superRefine(
    refinement: (
        arg: number,
        ctx: $RefinementCtx<number>,
    ) => void | Promise<void>,
): this
Parameters
- refinement: (arg: number, ctx: $RefinementCtx<number>) => void | Promise<void>
Returns this
Inherited from _ZodNumber.superRefine
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:33

overwrite

overwrite(fn: (x: number) => number): this
Parameters
- fn: (x: number) => number
Returns this
Inherited from _ZodNumber.overwrite
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:34

optional

optional(): ZodOptional<ZodCoercedNumber<T>>
Returns ZodOptional<ZodCoercedNumber<T>>
Inherited from _ZodNumber.optional
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:35

nonoptional

nonoptional(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
            message?: string;
        },
): ZodNonOptional<ZodCoercedNumber<T>>
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
          message?: string;
      }
  - string
  - {
    error?: string | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
    message?: string;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidType<unknown>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
Returns ZodNonOptional<ZodCoercedNumber<T>>
Inherited from _ZodNumber.nonoptional
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:36

nullable

nullable(): ZodNullable<ZodCoercedNumber<T>>
Returns ZodNullable<ZodCoercedNumber<T>>
Inherited from _ZodNumber.nullable
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:37

nullish

nullish(): ZodOptional<ZodNullable<ZodCoercedNumber<T>>>
Returns ZodOptional<ZodNullable<ZodCoercedNumber<T>>>
Inherited from _ZodNumber.nullish
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:38

default

default(def: number): ZodDefault<ZodCoercedNumber<T>>
Parameters
- def: number
Returns ZodDefault<ZodCoercedNumber<T>>
Inherited from _ZodNumber.default
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:39
default(def: () => number): ZodDefault<ZodCoercedNumber<T>>
Parameters
- def: () => number
Returns ZodDefault<ZodCoercedNumber<T>>
Inherited from _ZodNumber.default
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:40

prefault

prefault(def: () => T): ZodPrefault<ZodCoercedNumber<T>>
Parameters
- def: () => T
Returns ZodPrefault<ZodCoercedNumber<T>>
Inherited from _ZodNumber.prefault
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:41
prefault(def: T): ZodPrefault<ZodCoercedNumber<T>>
Parameters
- def: T
Returns ZodPrefault<ZodCoercedNumber<T>>
Inherited from _ZodNumber.prefault
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:42

array

array(): ZodArray<ZodCoercedNumber<T>>
Returns ZodArray<ZodCoercedNumber<T>>
Inherited from _ZodNumber.array
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:43

or

or<T extends SomeType>(option: T): ZodUnion<[ZodCoercedNumber<T>, T]>
Type Parameters
- T extends SomeType
Parameters
- option: T
Returns ZodUnion<[ZodCoercedNumber<T>, T]>
Inherited from _ZodNumber.or
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:44

and

and<T extends SomeType>(incoming: T): ZodIntersection<ZodCoercedNumber<T>, T>
Type Parameters
- T extends SomeType
Parameters
- incoming: T
Returns ZodIntersection<ZodCoercedNumber<T>, T>
Inherited from _ZodNumber.and
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:45

transform

transform<NewOut>(
    transform: (
        arg: number,
        ctx: $RefinementCtx<number>,
    ) => NewOut | Promise<NewOut>,
): ZodPipe<ZodCoercedNumber<T>, ZodTransform<Awaited<NewOut>, number>>
Type Parameters
- NewOut
Parameters
- transform: (arg: number, ctx: $RefinementCtx<number>) => NewOut | Promise<NewOut>
Returns ZodPipe<ZodCoercedNumber<T>, ZodTransform<Awaited<NewOut>, number>>
Inherited from _ZodNumber.transform
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:46

catch

catch(def: number): ZodCatch<ZodCoercedNumber<T>>
Parameters
- def: number
Returns ZodCatch<ZodCoercedNumber<T>>
Inherited from _ZodNumber.catch
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:47
catch(def: (ctx: $ZodCatchCtx) => number): ZodCatch<ZodCoercedNumber<T>>
Parameters
- def: (ctx: $ZodCatchCtx) => number
Returns ZodCatch<ZodCoercedNumber<T>>
Inherited from _ZodNumber.catch
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:48

pipe

pipe<T extends $ZodType<any, number, $ZodTypeInternals<any, number>>>(
target: $ZodType<any, number, $ZodTypeInternals<any, number>> | T,
): ZodPipe<ZodCoercedNumber<T>, T>
Type Parameters
- T extends $ZodType<any, number, $ZodTypeInternals<any, number>>
Parameters
- target: $ZodType<any, number, $ZodTypeInternals<any, number>> | T
Returns ZodPipe<ZodCoercedNumber<T>, T>
Inherited from _ZodNumber.pipe
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:49

readonly

readonly(): ZodReadonly<ZodCoercedNumber<T>>
Returns ZodReadonly<ZodCoercedNumber<T>>
Inherited from _ZodNumber.readonly
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:50

describe

describe(description: string): this
Returns a new instance that has been registered in z.globalRegistry with the specified description
Parameters
- description: string
Returns this
Inherited from _ZodNumber.describe
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:52

isOptional

isOptional(): boolean
Returns boolean
Deprecated
Try safe-parsing undefined (this is what isOptional does internally):
```
const schema = z.string().optional();
const isOptional = schema.safeParse(undefined).success; // true
```
Inherited from _ZodNumber.isOptional
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:65

isNullable

isNullable(): boolean
Returns boolean
Deprecated
Try safe-parsing null (this is what isNullable does internally):
```
const schema = z.string().nullable();
const isNullable = schema.safeParse(null).success; // true
```
Inherited from _ZodNumber.isNullable
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:74

gt

gt(
    value: number,
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
            message?: string;
            abort?: boolean;
        },
): this
Parameters
- value: number
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
          message?: string;
          abort?: boolean;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
        message?: string;
        abort?: boolean;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
Returns this
Inherited from _ZodNumber.gt
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:272

gte

gte(
    value: number,
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
            message?: string;
            abort?: boolean;
        },
): this
Identical to .min()
Parameters
- value: number
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
          message?: string;
          abort?: boolean;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
        message?: string;
        abort?: boolean;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
Returns this
Inherited from _ZodNumber.gte
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:274

min

min(
    value: number,
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
            message?: string;
            abort?: boolean;
        },
): this
Parameters
- value: number
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
          message?: string;
          abort?: boolean;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
        message?: string;
        abort?: boolean;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
Returns this
Inherited from _ZodNumber.min
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:275

lt

lt(
    value: number,
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
            message?: string;
            abort?: boolean;
        },
): this
Parameters
- value: number
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
          message?: string;
          abort?: boolean;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
        message?: string;
        abort?: boolean;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
Returns this
Inherited from _ZodNumber.lt
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:276

lte

lte(
    value: number,
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
            message?: string;
            abort?: boolean;
        },
): this
Identical to .max()
Parameters
- value: number
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
          message?: string;
          abort?: boolean;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
        message?: string;
        abort?: boolean;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
Returns this
Inherited from _ZodNumber.lte
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:278

max

max(
    value: number,
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
            message?: string;
            abort?: boolean;
        },
): this
Parameters
- value: number
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
          message?: string;
          abort?: boolean;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
        message?: string;
        abort?: boolean;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
Returns this
Inherited from _ZodNumber.max
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:279

int

int(
    params?:
        | string
        | {
            error?: | string
            | $ZodErrorMap<
                NonNullable<
                    | $ZodIssueInvalidType<unknown>
                    | $ZodIssueTooBig<"number">
                    | $ZodIssueTooSmall<"number">,
                >,
            >;
            message?: string;
            abort?: boolean;
        },
): this
Consider z.int() instead. This API is considered legacy; it will never be removed but a better alternative exists.
Parameters
- Optionalparams:
      | string
      | {
          error?: | string
          | $ZodErrorMap<
              NonNullable<
                  | $ZodIssueInvalidType<unknown>
                  | $ZodIssueTooBig<"number">
                  | $ZodIssueTooSmall<"number">,
              >,
          >;
          message?: string;
          abort?: boolean;
      }
  - string
  - {
        error?:
            | string
            | $ZodErrorMap<
                NonNullable<
                    | $ZodIssueInvalidType<unknown>
                    | $ZodIssueTooBig<"number">
                    | $ZodIssueTooSmall<"number">,
                >,
            >;
        message?: string;
        abort?: boolean;
    }
    Optionalerror?:
        | string
        | $ZodErrorMap<
            NonNullable<
                | $ZodIssueInvalidType<unknown>
                | $ZodIssueTooBig<"number">
                | $ZodIssueTooSmall<"number">,
            >,
        >
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
Returns this
Inherited from _ZodNumber.int
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:281

safe

safe(
    params?:
        | string
        | {
            error?: | string
            | $ZodErrorMap<
                NonNullable<
                    | $ZodIssueInvalidType<unknown>
                    | $ZodIssueTooBig<"number">
                    | $ZodIssueTooSmall<"number">,
                >,
            >;
            message?: string;
            abort?: boolean;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: | string
          | $ZodErrorMap<
              NonNullable<
                  | $ZodIssueInvalidType<unknown>
                  | $ZodIssueTooBig<"number">
                  | $ZodIssueTooSmall<"number">,
              >,
          >;
          message?: string;
          abort?: boolean;
      }
  - string
  - {
        error?:
            | string
            | $ZodErrorMap<
                NonNullable<
                    | $ZodIssueInvalidType<unknown>
                    | $ZodIssueTooBig<"number">
                    | $ZodIssueTooSmall<"number">,
                >,
            >;
        message?: string;
        abort?: boolean;
    }
    Optionalerror?:
        | string
        | $ZodErrorMap<
            NonNullable<
                | $ZodIssueInvalidType<unknown>
                | $ZodIssueTooBig<"number">
                | $ZodIssueTooSmall<"number">,
            >,
        >
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
Returns this
Deprecated
This is now identical to .int(). Only numbers in the safe integer range are accepted.
Inherited from _ZodNumber.safe
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:283

positive

positive(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
            message?: string;
            abort?: boolean;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
          message?: string;
          abort?: boolean;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
        message?: string;
        abort?: boolean;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
Returns this
Inherited from _ZodNumber.positive
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:284

nonnegative

nonnegative(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
            message?: string;
            abort?: boolean;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
          message?: string;
          abort?: boolean;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
        message?: string;
        abort?: boolean;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
Returns this
Inherited from _ZodNumber.nonnegative
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:285

negative

negative(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
            message?: string;
            abort?: boolean;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
          message?: string;
          abort?: boolean;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
        message?: string;
        abort?: boolean;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
Returns this
Inherited from _ZodNumber.negative
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:286

nonpositive

nonpositive(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
            message?: string;
            abort?: boolean;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
          message?: string;
          abort?: boolean;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
        message?: string;
        abort?: boolean;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
Returns this
Inherited from _ZodNumber.nonpositive
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:287

multipleOf

multipleOf(
    value: number,
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueNotMultipleOf<number | bigint>>;
            message?: string;
            abort?: boolean;
        },
): this
Parameters
- value: number
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueNotMultipleOf<number | bigint>>;
          message?: string;
          abort?: boolean;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueNotMultipleOf<number | bigint>>;
        message?: string;
        abort?: boolean;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueNotMultipleOf<number | bigint>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
Returns this
Inherited from _ZodNumber.multipleOf
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:288

step

step(
    value: number,
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueNotMultipleOf<number | bigint>>;
            message?: string;
            abort?: boolean;
        },
): this
Parameters
- value: number
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueNotMultipleOf<number | bigint>>;
          message?: string;
          abort?: boolean;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueNotMultipleOf<number | bigint>>;
        message?: string;
        abort?: boolean;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueNotMultipleOf<number | bigint>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
Returns this
Deprecated
Use .multipleOf() instead.
Inherited from _ZodNumber.step
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:290

finite

finite(params?: unknown): this
Parameters
- Optionalparams: unknown
Returns this
Deprecated
In v4 and later, z.number() does not allow infinite values by default. This is a no-op.
Inherited from _ZodNumber.finite
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:292

Interface ZodCoercedNumber<T>

Type Parameters

Hierarchy (View Summary)

Index

Properties

Methods

Properties

def

type

_def

Deprecated

_output

Deprecated

_input

Deprecated

spa

Optionaldescription

minValue

maxValue

isInt

Deprecated

isFinite

Deprecated

format

_zod

~standard

Methods

check

Parameters

Returns this

clone

Parameters

Returns this

register

Type Parameters

Parameters

Returns this

brand

Type Parameters

Parameters

Returns PropertyKey extends T ? ZodCoercedNumber<T> : $ZodBranded<ZodCoercedNumber<T>, T>

parse

Parameters

Returns number

safeParse

Parameters

Returns ZodSafeParseResult<number>

parseAsync

Parameters

Returns Promise<number>

safeParseAsync

Parameters

Returns Promise<ZodSafeParseResult<number>>

encode

Parameters

Returns T

decode

Parameters

Returns number

encodeAsync

Parameters

Returns Promise<T>

decodeAsync

Parameters

Returns Promise<number>

safeEncode

Parameters

Returns ZodSafeParseResult<T>

safeDecode

Parameters

Returns ZodSafeParseResult<number>

safeEncodeAsync

Parameters

Returns Promise<ZodSafeParseResult<T>>

safeDecodeAsync

Parameters

Returns Promise<ZodSafeParseResult<number>>

refine

Parameters

Optionalerror?: string | $ZodErrorMap<NonNullable<$ZodIssue>>

`Optional`description

Returns PropertyKey extends T
? ZodCoercedNumber<T>
: $ZodBranded<ZodCoercedNumber<T>, T>

`Optional`error?: string | $ZodErrorMap<NonNullable<$ZodIssue>>

`Optional`message?: string

`Optional`abort?: boolean

`Optional`when?: (payload: ParsePayload) => boolean

`Optional`path?: PropertyKey[]

`Optional`params?: Record<string, any>

`Optional`error?: string | $ZodErrorMap<$ZodIssueInvalidType<unknown>>

`Optional`message?: string

Returns
| undefined
| {
id?: string;
title?: string;
description?: string;
deprecated?: boolean;
[key: string]: unknown;
}