requireNonObject

function requireNonObject<T>(
  value: T | object,
  message: string = "Expected a non-object value."
): T;

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`	`T \\| object`	The value to validate.
`message` (optional) `= "Expected a non-object value."`	`string`	The message of the exception. A default is used when omitted.

Returns

T — the same value, with an object excluded from its type.

Throws

Exception	Condition
`IllegalArgumentException`	the value is an object.

Examples

What passes and what does not

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

Source

src/lang/base/requireNonObject.ts

23 September 2026

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

apps-script-utils 2.1.1 Help