isValidSpreadsheetId
function isValidSpreadsheetId(value: unknown): value is string;
At least 25 characters of letters, digits, hyphens and underscores — the id that sits in a spreadsheet URL between /d/ and /edit. Nothing is fetched: the format is all that is checked.
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 |
|---|---|---|
|
| The value to check. |
Returns
boolean — true when the value is a spreadsheet id; otherwise false.
In TypeScript the guard narrows value to string inside the branch.
Examples
What passes and what does not
isValidSpreadsheetId("1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms"); // => true
isValidSpreadsheetId("short-id"); // => false
isValidSpreadsheetId("has space in it and is long enough to pass"); // => false
See also
Source
23 September 2026
This documentation was generated with AI (Claude) from the library's source code.