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