requireSpreadsheet

function requireSpreadsheet(
  value: unknown,
  message: string = "Required Spreadsheet object is missing or invalid."
): 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
`value`	`unknown`	The value to validate.
`message` (optional) `= "Required Spreadsheet object is missing or invalid."`	`string`	The message of the exception. A default is used when omitted.

Returns

GoogleAppsScript.Spreadsheet.Spreadsheet — the same value, typed as a spreadsheet.

Throws

Exception	Condition
`InvalidSpreadsheetException`	the value is not a spreadsheet.

Examples

What passes and what does not

const spreadsheet = SpreadsheetApp.getActive();

requireSpreadsheet(spreadsheet); // => spreadsheet
requireSpreadsheet({}); // throws InvalidSpreadsheetException
requireSpreadsheet(null); // throws InvalidSpreadsheetException

Source

src/appsscript/sheet/requireSpreadsheet.ts

23 September 2026

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

apps-script-utils 2.1.1 Help