Skip to content

Integer

integer validates that a number is an integer (whole number).

It enforces strict numeric validation and rejects any non-number value or non-integer number. If the value is not a number or is not an integer, the rule emits a single validation event. Otherwise, it produces no validation output.

Signature

Through the API:

.integer()

And internally:

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

Events

Event code Description
type.not.valid Value is not structurally a number
number.not.integer Number is not an integer

Design rationale

  • Provides a strict, predictable integer validation.
  • Rejects floating-point numbers explicitly.
  • Rejects non-number values with a clear structural-type diagnostic.
  • Never coerces or normalizes — validation is explicit and opt-in.
  • Emits exactly one event per failure for clarity and composability.
  • Async-compatible and returns a readonly array of JaneEvent objects.

Invoke

integer 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 number, emits type.not.valid.
  • If the value is a number but not an integer, emits number.not.integer.
  • If the value is an integer number → returns an empty result set.

Examples

Valid integer

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

Floating-point number

await integer(42.5, "$");
// → [
//     JaneEvent{
//       kind: "error",
//       code: "number.not.integer",
//       path: "$",
//       ...
//     }
//   ]

Non-number value

await integer("42", "$");
// → [
//     JaneEvent{
//       kind: "error",
//       code: "type.not.valid",
//       path: "$",
//       ...
//     }
//   ]