apps-script-utils 2.1.1 Help

requireNull

function requireNull(value: unknown, message: string = "Expected null."): null;

Strictly null. undefined is a separate case — isNil covers both.

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 null."

string

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

Returns

null — the same value, typed as null.

Throws

Exception

Condition

IllegalArgumentException

the value is not null.

Examples

What passes and what does not

requireNull(null); // => null requireNull(undefined); // throws IllegalArgumentException requireNull(0); // throws IllegalArgumentException

See also

Source

src/lang/base/requireNull.ts

23 September 2026
requireNonUndefinedrequireNumber

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