nonScalar

function nonScalar<T>(value: T | string | number | boolean | symbol | bigint): value is T;

nonScalar(value) is the same test as !isScalar(value), written so that a guard clause reads as a sentence rather than as a negation.

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 check.

Returns

boolean — true when the value is not a scalar; otherwise false.

In TypeScript the guard narrows value to T inside the branch.

Examples

What passes and what does not

nonScalar({}); // => true
nonScalar([]); // => true
nonScalar(null); // => true
nonScalar("abc"); // => false
nonScalar(1); // => false
nonScalar(true); // => false
nonScalar(10n); // => false

Source

src/lang/base/nonScalar.ts

23 September 2026

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

apps-script-utils 2.1.1 Help