requireUi

function requireUi(
  value: unknown,
  message: string = "Expected a Ui object."
): GoogleAppsScript.Base.Ui;

У сервісного об'єкта Apps Script немає конструктора, з яким скрипт міг би порівняти значення, тому перевірка читає тег, який об'єкт повідомляє про себе сам: value.toString() === "Ui". Звичайний об'єкт з таким самим тегом теж пройде — на практиці це тестовий дубль.

isX та nonX відповідають на питання й ніколи не переривають виконання; requireX і requireNonX повертають значення або викидають виняток. Схему розібрано в Домовленості про перевірки.

Параметри

Параметр	Тип	Опис
`value`	`unknown`	Значення, яке потрібно перевірити.
`message` (необов'язковий) `= "Expected a Ui object."`	`string`	Повідомлення винятку. Якщо не задано, використовується типове повідомлення.

Повертає

GoogleAppsScript.Base.Ui — те саме значення, вже перевірене як об'єкт Ui.

Винятки

Виняток	Умова
`IllegalArgumentException`	значення не є об'єктом Ui.

Приклади

Що проходить, а що ні

const ui = SpreadsheetApp.getUi();

requireUi(ui); // => ui
requireUi({}); // throws IllegalArgumentException
requireUi(null); // throws IllegalArgumentException

Дивіться також

Вихідний код

src/appsscript/ui/requireUi.ts

23 September 2026

Цю документацію згенеровано нейромережею (Claude) на основі вихідного коду бібліотеки.