bigint

Creates a bigint schema.

// Bigint schema with an optional pipe
const Schema = bigint(pipe);

// Bigint schema with an optional message and pipe
const Schema = bigint(message, pipe);

Parameters

• message ErrorMessage | undefined
• pipe Pipe<bigint> | undefined

Explanation

With bigint you can validate the data type of the input and with pipe you can transform and validate the further details of the bigint. If the input is not a bigint, you can use message to customize the error message.

Returns

• Schema BigintSchema

Examples

The following examples show how bigint can be used.

Force minimum

Schema that forces a minimum bigint value.

const MinBigintSchema = bigint([toMinValue(10n)]);

Validate maximum

Schema that validates a maximum bigint value.

const MaxBigintSchema = bigint([maxValue(999n)]);

Related

The following APIs can be combined with bigint.

Schemas

• array,
• intersect,
• lazy,
• map,
• nonNullable,
• nonNullish,
• nonOptional,
• nullable,
• nullish,
• object,
• optional,
• record,
• set,
• tuple,
• union

Methods

• brand,
• coerce,
• fallback,
• getDefault,
• getDefaults,
• getFallback,
• getFallbacks,
• is,
• parse,
• safeParse,
• transform

Transformations

• toCustom,
• toMaxValue,
• toMinValue

Validations

• custom,
• maxValue,
• minValue,
• notValue,
• value