apps-script-utils (Українська) 2.1.1 Help

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) на основі вихідного коду бібліотеки.