apps-script-utils (Français) 2.1.1 Help

requireRange

function requireRange(value: unknown, message?: string): GoogleAppsScript.Spreadsheet.Range;

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() === "Range". 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)

string

Le message de l'exception. À défaut, un message par défaut est utilisé.

Valeur de retour

GoogleAppsScript.Spreadsheet.Range — la même valeur, typée comme une plage.

Exceptions

Exception

Condition

InvalidRangeException

la valeur n'est pas une plage.

Exemples

Ce qui passe et ce qui ne passe pas

const range = SpreadsheetApp.getActiveRange(); requireRange(range); // => range requireRange({}); // throws InvalidRangeException requireRange(null); // throws InvalidRangeException

Voir aussi

Code source

src/appsscript/sheet/requireRange.ts

23 September 2026

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