Interface $ZodBigIntFormatDef

interface $ZodBigIntFormatDef {
    abort?: boolean;
    check: "bigint_format";
    checks?: z.core.$ZodCheck<never>[];
    coerce?: boolean;
    error?: $ZodErrorMap<never>;
    format: $ZodBigIntFormats | undefined;
    type: "bigint";
    when?: (payload: ParsePayload) => boolean;
}

Hierarchy (View Summary)

$ZodBigIntDef
$ZodCheckBigIntFormatDef
- $ZodBigIntFormatDef

Index

Properties

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

Properties

`Optional`abort

abort?: boolean

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

check

check: "bigint_format"

`Optional`checks

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

`Optional`coerce

coerce?: boolean

`Optional`error

error?: $ZodErrorMap<never>

format

format: $ZodBigIntFormats | undefined

type

type: "bigint"

`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).