apps-script-utils 2.1.1 Help

isValidSheetName

function isValidSheetName(value: unknown): value is 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 check.

Returns

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

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

Examples

What passes and what does not

isValidSheetName("Data"); // => true isValidSheetName("Report 2026"); // => true isValidSheetName("history"); // => false isValidSheetName("Data/2026"); // => false isValidSheetName(""); // => false

See also

Source

src/appsscript/sheet/isValidSheetName.ts

23 September 2026

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