requireValidSheetName

function requireValidSheetName(
  value: unknown,
  message: string = "Expected a valid sheet name."
): string;

What Google Sheets accepts: at most 100 characters, not blank, none of \ / ? * [ ], and not the reserved name history in any case.

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 name."`	`string`	The message of the exception. A default is used when omitted.

Returns

string — the same value, typed as a sheet name.

Throws

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

Examples

What passes and what does not

requireValidSheetName("Data"); // => "Data"
requireValidSheetName("Report 2026"); // => "Report 2026"
requireValidSheetName("history"); // throws IllegalArgumentException
requireValidSheetName("Data/2026"); // throws IllegalArgumentException

Source

src/appsscript/sheet/requireValidSheetName.ts

23 September 2026

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

apps-script-utils 2.1.1 Help