isSpreadsheet
function isSpreadsheet(value: unknown): value is GoogleAppsScript.Spreadsheet.Spreadsheet;
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() === "Spreadsheet". 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 |
|---|---|---|
|
| The value to check. |
Returns
boolean — true when the value is a spreadsheet; otherwise false.
In TypeScript the guard narrows value to GoogleAppsScript.Spreadsheet.Spreadsheet inside the branch.
Examples
What passes and what does not
const spreadsheet = SpreadsheetApp.getActive();
isSpreadsheet(spreadsheet); // => true
isSpreadsheet({}); // => false
isSpreadsheet(null); // => false
See also
Source
23 September 2026
This documentation was generated with AI (Claude) from the library's source code.