requireRange

function requireRange(value: unknown, message?: string): GoogleAppsScript.Spreadsheet.Range;

An Apps Script service object has no constructor a script can test against, so the guard reads the tag the object reports for itself: value.toString() === "Range". A plain object that reports the same tag passes too, which in practice means a test double.

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)	`string`	The message of the exception. A default is used when omitted.

Returns

GoogleAppsScript.Spreadsheet.Range — the same value, typed as a range.

Throws

Exception	Condition
`InvalidRangeException`	the value is not a range.

Examples

What passes and what does not

const range = SpreadsheetApp.getActiveRange();

requireRange(range); // => range
requireRange({}); // throws InvalidRangeException
requireRange(null); // throws InvalidRangeException

Source

src/appsscript/sheet/requireRange.ts

23 September 2026

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

apps-script-utils 2.1.1 Help