requireValidSheetId

function requireValidSheetId(
  value: unknown,
  message: string = "Expected a valid sheet id."
): number;

Apps Script нумерует листы с нуля, поэтому идентификатор листа — неотрицательное безопасное целое, то же правило, что у isCountable. У первого листа таблицы идентификатор 0.

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

Параметры

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

Возвращает

number — то же значение, уже проверенное как идентификатор листа.

Исключения

Исключение	Условие
`IllegalArgumentException`	значение не является идентификатором листа.

Примеры

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

requireValidSheetId(0); // => 0
requireValidSheetId(1234567890); // => 1234567890
requireValidSheetId(-1); // throws IllegalArgumentException
requireValidSheetId(1.5); // throws IllegalArgumentException

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

Исходный код

src/appsscript/sheet/requireValidSheetId.ts

23 September 2026

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