requireSheet

function requireSheet(value: unknown, message?: string): GoogleAppsScript.Spreadsheet.Sheet;

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

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

Параметры

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

Возвращает

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

Исключения

Исключение	Условие
`InvalidSheetException`	значение не является листом.

Примеры

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

const sheet = SpreadsheetApp.getActiveSheet();

requireSheet(sheet); // => sheet
requireSheet({}); // throws InvalidSheetException
requireSheet(null); // throws InvalidSheetException

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

Исходный код

src/appsscript/sheet/requireSheet.ts

23 September 2026

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