requireValidSheetId

function requireValidSheetId(
  value: unknown,
  message: string = "Expected a valid sheet id."
): number;

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 validate.
`message` (optional) `= "Expected a valid sheet id."`	`string`	The message of the exception. A default is used when omitted.

Returns

number — the same value, typed as a sheet id.

Throws

Exception	Condition
`IllegalArgumentException`	the value is not a sheet id.

Examples

What passes and what does not

requireValidSheetId(0); // => 0
requireValidSheetId(1234567890); // => 1234567890
requireValidSheetId(-1); // throws IllegalArgumentException
requireValidSheetId(1.5); // throws IllegalArgumentException

Source

src/appsscript/sheet/requireValidSheetId.ts

23 September 2026

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

apps-script-utils 2.1.1 Help