requireNonScalar

function requireNonScalar<T>(
  value: T | string | number | boolean | symbol | bigint,
  message: string = "Expected a non-scalar value."
): T;

A primitive that carries a single value: string, number, boolean, symbol or bigint. null and undefined are primitives too, but they carry no value and do not qualify.

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

Returns

T — the same value, with a scalar excluded from its type.

Throws

Exception	Condition
`IllegalArgumentException`	the value is a scalar.

Examples

What passes and what does not

requireNonScalar({}); // => {}
requireNonScalar([]); // => []
requireNonScalar("abc"); // throws IllegalArgumentException
requireNonScalar(1); // throws IllegalArgumentException

Source

src/lang/base/requireNonScalar.ts

23 September 2026

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

apps-script-utils 2.1.1 Help