requireNonFloat

function requireNonFloat<T>(
  value: T | number,
  message: string = "Expected a value without a fractional part."
): T;

JavaScript has one numeric type, so 1.0 and 1 are the same value: the question answered is whether a fraction survives at runtime, not how the literal was written. The infinities have no fraction and are excluded.

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 without a fractional part."`	`string`	The message of the exception. A default is used when omitted.

Returns

T — the same value, with a number with a fractional part excluded from its type.

Throws

Exception	Condition
`IllegalArgumentException`	the value is a number with a fractional part.

Examples

What passes and what does not

requireNonFloat(42); // => 42
requireNonFloat(1.0); // => 1.0
requireNonFloat(1.5); // throws IllegalArgumentException
requireNonFloat(-0.1); // throws IllegalArgumentException

Source

src/lang/number/requireNonFloat.ts

23 September 2026

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

apps-script-utils 2.1.1 Help