isRange

function isRange(value: unknown): value is 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 check.

Returns

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

In TypeScript the guard narrows value to GoogleAppsScript.Spreadsheet.Range inside the branch.

Examples

What passes and what does not

const range = SpreadsheetApp.getActiveRange();

isRange(range); // => true
isRange({}); // => false
isRange(null); // => false

Source

src/appsscript/sheet/isRange.ts

23 September 2026

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

apps-script-utils 2.1.1 Help