apps-script-utils 2.1.1 Help

requireObject

function requireObject(value: unknown, message: string = "Expected an object."): object;

The test is typeof value === "object" with null excluded, so arrays, dates and class instances all count, while a function does not. isObjectLike is the one that also accepts functions.

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 an object."

string

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

Returns

object — the same value, typed as an object.

Throws

Exception

Condition

IllegalArgumentException

the value is not an object.

Examples

What passes and what does not

requireObject({}); // => {} requireObject([]); // => [] requireObject(null); // throws IllegalArgumentException requireObject("abc"); // throws IllegalArgumentException

See also

Source

src/lang/base/requireObject.ts

23 September 2026

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