apps-script-utils 2.1.1 Help

requireValidSlideId

function requireValidSlideId( value: unknown, message: string = "Expected a valid slide id." ): string;

Letters, digits, hyphens and underscores, at least one of them. Slide ids are short — p1 is a perfectly ordinary one — so no minimum length is imposed.

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 slide id."

string

The message of the exception. A default is used when omitted.

Returns

string — the same value, typed as a slide id.

Throws

Exception

Condition

IllegalArgumentException

the value is not a slide id.

Examples

What passes and what does not

requireValidSlideId("p1"); // => "p1" requireValidSlideId("SLIDES_api123"); // => "SLIDES_api123" requireValidSlideId("has space"); // throws IllegalArgumentException requireValidSlideId(""); // throws IllegalArgumentException

See also

Source

src/appsscript/slide/requireValidSlideId.ts

23 September 2026

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