apps-script-utils (Русский) 2.1.1 Help

isUi

function isUi(value: unknown): value is GoogleAppsScript.Base.Ui;

У сервисного объекта Apps Script нет конструктора, с которым скрипт мог бы сравнить значение, поэтому проверка читает тег, который объект сообщает о себе сам: value.toString() === "Ui". Обычный объект с таким же тегом тоже пройдёт — на практике это тестовый дубль.

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

Параметры

Параметр

Тип

Описание

value

unknown

Проверяемое значение.

Возвращает

boolean — true, если значение является объектом Ui; иначе false.

В TypeScript внутри ветки значение value сужается до GoogleAppsScript.Base.Ui.

Примеры

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

const ui = SpreadsheetApp.getUi(); isUi(ui); // => true isUi({}); // => false isUi(null); // => false

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

Исходный код

src/appsscript/ui/isUi.ts

23 September 2026

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