nonUi

function nonUi<T>(value: T | GoogleAppsScript.Base.Ui): value is T;

nonUi(value) is the same test as !isUi(value), written so that a guard clause reads as a sentence rather than as a negation.

An Apps Script service object has no constructor a script can test against, so the guard reads the tag the object reports for itself: value.toString() === "Ui". A plain object that reports the same tag passes too, which in practice means a test double.

isX and nonX answer a question and never interrupt control flow; requireX and requireNonX hand the value back or throw. The scheme is explained in Validation conventions.

Parameters

Parameter	Type	Description
`value`	`T \\| GoogleAppsScript.Base.Ui`	The value to check.

Returns

boolean — true when the value is not a Ui object; otherwise false.

In TypeScript the guard narrows value to T inside the branch.

Examples

What passes and what does not

const ui = SpreadsheetApp.getUi();

nonUi({}); // => true
nonUi(null); // => true
nonUi(ui); // => false

Source

src/appsscript/ui/nonUi.ts

23 September 2026

This documentation was generated with AI (Claude) from the library's source code.

apps-script-utils 2.1.1 Help