Interface $ZodNumberFormatDef

interface $ZodNumberFormatDef {
    type: "number";
    coerce?: boolean;
    error?: $ZodErrorMap<never>;
    checks?: z.core.$ZodCheck<never>[];
    check: "number_format";
    format: $ZodNumberFormats;
    abort?: boolean;
    when?: (payload: ParsePayload) => boolean;
}

Hierarchy (View Summary)

$ZodNumberDef
$ZodCheckNumberFormatDef
- $ZodNumberFormatDef

Index

Properties

type coerce? error? checks? check format abort? when?

Properties

type

type: "number"

`Optional`coerce

coerce?: boolean

`Optional`error

error?: $ZodErrorMap<never>

`Optional`checks

checks?: z.core.$ZodCheck<never>[]

check

check: "number_format"

format

format: $ZodNumberFormats

`Optional`abort

abort?: boolean

If true, no later checks will be executed if this check fails. Default false.

`Optional`when

when?: (payload: ParsePayload) => boolean

If provided, this check will only be executed if the function returns true. Defaults to payload => z.util.isAborted(payload).