requireSpreadsheet

function requireSpreadsheet(
  value: unknown,
  message: string = "Required Spreadsheet object is missing or invalid."
): GoogleAppsScript.Spreadsheet.Spreadsheet;

У сервисного объекта Apps Script нет конструктора, с которым скрипт мог бы сравнить значение, поэтому проверка читает тег, который объект сообщает о себе сам: value.toString() === "Spreadsheet". Обычный объект с таким же тегом тоже пройдёт — на практике это тестовый дубль.

isX и nonX отвечают на вопрос и никогда не прерывают выполнение; requireX и requireNonX возвращают значение или выбрасывают исключение. Схема разобрана в Соглашения о проверках.

Параметры

Параметр	Тип	Описание
`value`	`unknown`	Значение, которое нужно проверить.
`message` (необязательный) `= "Required Spreadsheet object is missing or invalid."`	`string`	Сообщение исключения. Если не задано, используется сообщение по умолчанию.

Возвращает

GoogleAppsScript.Spreadsheet.Spreadsheet — то же значение, уже проверенное как таблицу.

Исключения

Исключение	Условие
`InvalidSpreadsheetException`	значение не является таблицей.

Примеры

Что проходит, а что нет

const spreadsheet = SpreadsheetApp.getActive();

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

Смотрите также

Исходный код

src/appsscript/sheet/requireSpreadsheet.ts

23 September 2026

Эта документация сгенерирована нейросетью (Claude) на основе исходного кода библиотеки.