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