apps-script-utils 2.1.1 Help

nonValidSheetId

function nonValidSheetId(value: unknown): boolean;

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

Apps Script numbers its sheets from zero, so a sheet id is a non-negative safe integer — the same rule isCountable applies. The id of the first sheet in a spreadsheet is 0.

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

unknown

The value to check.

Returns

boolean — true when the value is not a sheet id; otherwise false.

Examples

What passes and what does not

nonValidSheetId(-1); // => true nonValidSheetId(1.5); // => true nonValidSheetId("0"); // => true nonValidSheetId(0); // => false nonValidSheetId(1234567890); // => false

See also

Source

src/appsscript/sheet/nonValidSheetId.ts

23 September 2026

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