requireSlide

function requireSlide(
  value: unknown,
  message: string = "Required Slide context is missing or invalid."
): GoogleAppsScript.Slides.Slide;

An Apps Script service object has no constructor a script can test against, so the guard looks for the methods that define the type — getObjectId, getPageElementById. A stub that implements them passes, which is what makes code using this guard testable outside the runtime.

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) `= "Required Slide context is missing or invalid."`	`string`	The message of the exception. A default is used when omitted.

Returns

GoogleAppsScript.Slides.Slide — the same value, typed as a slide.

Throws

Exception	Condition
`SlideNotFoundException`	the value is not a slide.

Examples

What passes and what does not

const slide = SlidesApp.getActivePresentation().getSlides()[0];

requireSlide(slide); // => slide
requireSlide({}); // throws SlideNotFoundException
requireSlide(null); // throws SlideNotFoundException

Source

src/appsscript/slide/requireSlide.ts

23 September 2026

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

apps-script-utils 2.1.1 Help