requireNonSafeInteger

function requireNonSafeInteger<T>(
  value: T | number,
  message: string = "Expected a value that is not a safe integer."
): T;

An integer that an IEEE-754 double represents exactly. Beyond that range distinct mathematical integers collapse onto the same value and arithmetic quietly stops being exact.

isX and nonX answer a question and never interrupt control flow; requireX and requireNonX hand the value back or throw. The scheme is explained in Validation conventions.

Parameters

Parameter	Type	Description
`value`	`T \\| number`	The value to validate.
`message` (optional) `= "Expected a value that is not a safe integer."`	`string`	The message of the exception. A default is used when omitted.

Returns

T — the same value, with a safe integer excluded from its type.

Throws

Exception	Condition
`IllegalArgumentException`	the value is a safe integer.

Examples

What passes and what does not

requireNonSafeInteger(Number.MAX_SAFE_INTEGER + 2); // => Number.MAX_SAFE_INTEGER + 2
requireNonSafeInteger(1.5); // => 1.5
requireNonSafeInteger(42); // throws IllegalArgumentException
requireNonSafeInteger(Number.MAX_SAFE_INTEGER); // throws IllegalArgumentException

Source

src/lang/number/requireNonSafeInteger.ts

23 September 2026

This documentation was generated with AI (Claude) from the library's source code.

apps-script-utils 2.1.1 Help