Skip to content

Bigint max

bigintMax validates that a value is a string representing a BigInt less than or equal to a specified maximum.

It enforces strict bigint‑string semantics: the value must be a string, must parse successfully as a BigInt literal, and must not exceed the provided max. If any condition fails, the rule emits a single validation event. Otherwise, it produces no validation output.

Signature

Through the API:

.bigintMax(max);

And internally:

export const bigintMax: (max: bigint) => ValidationRule
(value: unknown, path: FieldPath) => Promise<ReadonlyArray<JaneEvent>>

Events

Event code Description
bigint.not.string Value is not a string.
bigint.not.bigint String is not a valid bigint literal.
bigint.too.large Parsed bigint is greater than the allowed maximum.

Design rationale

  • Enforces strict bigint‑string validation with no coercion or normalization.
  • Rejects non‑string values early with a structural‑type diagnostic.
  • Treats empty strings and malformed literals as invalid bigint values.
  • Uses JavaScript’s BigInt() constructor for canonical parsing.
  • Emits exactly one event per failure for clarity and composability.
  • Pure, total, async‑compatible, and returns a readonly array of JaneEvent objects.
  • Preserves the provided path and supports pipeline‑level userMessage overrides.
  • Marks the rule as a Jane factory to prevent bigint serialization loss.

Invoke

bigintMax runs only when explicitly included in a boundary or pipeline. It does not run automatically.

The rule activates when:

  • The value is any JavaScript value.
  • If the value is not a string, emits bigint.not.string.
  • If the string is empty or cannot be parsed by BigInt, emits bigint.not.bigint.
  • If the parsed bigint is greater than max, emits bigint.too.large.
  • Otherwise, returns an empty result set.

Examples

Valid — bigint string less than or equal to max

const rule = bigintMax(100n);

await rule("42", "$");
// → []

Invalid — not a string

await bigintMax(10n)(123, "$");
// → [
//     JaneEvent{
//       kind: "error",
//       code: "bigint.not.string",
//       path: "$",
//       ...
//     }
//   ]

Invalid — malformed bigint literal

await bigintMax(10n)("01", "$");
// → [
//     JaneEvent{
//       kind: "error",
//       code: "bigint.not.bigint",
//       path: "$",
//       ...
//     }
//   ]

Invalid — value exceeds max

await bigintMax(50n)("99", "$");
// → [
//     JaneEvent{
//       kind: "error",
//       code: "bigint.too.large",
//       path: "$",
//       ...
//     }
//   ]