apps-script-utils 2.1.1 Help

requireBoolean

function requireBoolean(value: unknown, message: string = "Expected a boolean."): boolean;

Only the two primitives pass. new Boolean(false) is an object, and the strings "true" and "false" are strings.

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

unknown

The value to validate.

message (optional) = "Expected a boolean."

string

The message of the exception. A default is used when omitted.

Returns

boolean — the same value, typed as a boolean.

Throws

Exception

Condition

IllegalArgumentException

the value is not a boolean.

Examples

What passes and what does not

requireBoolean(true); // => true requireBoolean(false); // => false requireBoolean("true"); // throws IllegalArgumentException requireBoolean(1); // throws IllegalArgumentException

See also

Source

src/lang/base/requireBoolean.ts

23 September 2026
requireArrayrequireConsistent2DArray

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