apps-script-utils 2.1.1 Help

requireObjectLike

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

Everything isObject accepts, plus functions: the question it answers is whether properties can be read off the value at all.

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-like value.

Throws

Exception

Condition

IllegalArgumentException

the value is not object-like.

Examples

What passes and what does not

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

See also

Source

src/lang/base/requireObjectLike.ts

23 September 2026
requireObjectrequireRegExp

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