requireSheet

function requireSheet(value: unknown, message?: string): GoogleAppsScript.Spreadsheet.Sheet;

Ein Apps-Script-Dienstobjekt hat keinen Konstruktor, gegen den ein Skript prüfen könnte, also liest die Prüfung den Tag, den das Objekt über sich selbst meldet: value.toString() === "Sheet". Ein einfaches Objekt mit demselben Tag besteht ebenfalls — in der Praxis ist das ein Test-Double.

isX und nonX beantworten eine Frage und unterbrechen den Ablauf nie; requireX und requireNonX geben den Wert zurück oder werfen. Das Schema erklärt Konventionen der Prüfungen.

Parameter

Parameter	Typ	Beschreibung
`value`	`unknown`	Der zu validierende Wert.
`message` (optional)	`string`	Die Meldung der Ausnahme. Ohne Angabe wird eine Standardmeldung verwendet.

Rückgabewert

GoogleAppsScript.Spreadsheet.Sheet — denselben Wert, typisiert als ein Blatt.

Ausnahmen

Ausnahme	Bedingung
`InvalidSheetException`	der Wert ist nicht ein Blatt.

Beispiele

Was besteht und was nicht

const sheet = SpreadsheetApp.getActiveSheet();

requireSheet(sheet); // => sheet
requireSheet({}); // throws InvalidSheetException
requireSheet(null); // throws InvalidSheetException

Siehe auch

Quellcode

src/appsscript/sheet/requireSheet.ts

23 September 2026

Diese Dokumentation wurde mit KI (Claude) aus dem Quellcode der Bibliothek erzeugt.