requireSpreadsheet

function requireSpreadsheet(
  value: unknown,
  message: string = "Required Spreadsheet object is missing or invalid."
): GoogleAppsScript.Spreadsheet.Spreadsheet;

Un objet de service Apps Script n'a pas de constructeur contre lequel un script pourrait tester, alors le garde lit le tag que l'objet déclare pour lui-même : value.toString() === "Spreadsheet". Un objet ordinaire qui déclare le même tag passe aussi, ce qui en pratique désigne un double de test.

isX et nonX répondent à une question sans jamais interrompre le flot ; requireX et requireNonX rendent la valeur ou lèvent. Le schéma est expliqué dans Conventions de validation.

Paramètres

Paramètre	Type	Description
`value`	`unknown`	La valeur à valider.
`message` (facultatif) `= "Required Spreadsheet object is missing or invalid."`	`string`	Le message de l'exception. À défaut, un message par défaut est utilisé.

Valeur de retour

GoogleAppsScript.Spreadsheet.Spreadsheet — la même valeur, typée comme un classeur.

Exceptions

Exception	Condition
`InvalidSpreadsheetException`	la valeur n'est pas un classeur.

Exemples

Ce qui passe et ce qui ne passe pas

const spreadsheet = SpreadsheetApp.getActive();

requireSpreadsheet(spreadsheet); // => spreadsheet
requireSpreadsheet({}); // throws InvalidSpreadsheetException
requireSpreadsheet(null); // throws InvalidSpreadsheetException

Voir aussi

Code source

src/appsscript/sheet/requireSpreadsheet.ts

23 September 2026

Cette documentation a été générée par une IA (Claude) à partir du code source de la bibliothèque.