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

requireValidSheetId

function requireValidSheetId( value: unknown, message: string = "Expected a valid sheet id." ): number;

Apps Script numérote les feuilles à partir de zéro : un identifiant de feuille est un entier sûr non négatif — la règle qu'applique isCountable. La première feuille d'un classeur porte l'identifiant 0.

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) = "Expected a valid sheet id."

string

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

Valeur de retour

number — la même valeur, typée comme un identifiant de feuille.

Exceptions

Exception

Condition

IllegalArgumentException

la valeur n'est pas un identifiant de feuille.

Exemples

Ce qui passe et ce qui ne passe pas

requireValidSheetId(0); // => 0 requireValidSheetId(1234567890); // => 1234567890 requireValidSheetId(-1); // throws IllegalArgumentException requireValidSheetId(1.5); // throws IllegalArgumentException

Voir aussi

Code source

src/appsscript/sheet/requireValidSheetId.ts

23 September 2026

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