requireNonInteger

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

A number with no fractional part. Nothing is coerced, so the string "42" is not an integer, and NaN is not either.

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 an integer."`	`string`	The message of the exception. A default is used when omitted.

Returns

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

Throws

Exception	Condition
`IllegalArgumentException`	the value is an integer.

Examples

What passes and what does not

requireNonInteger(1.5); // => 1.5
requireNonInteger(NaN); // => NaN
requireNonInteger(42); // throws IllegalArgumentException
requireNonInteger(-7); // throws IllegalArgumentException

Source

src/lang/number/requireNonInteger.ts

23 September 2026

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

apps-script-utils 2.1.1 Help