requireSpreadsheet

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

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() === "Spreadsheet". 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) `= "Required Spreadsheet object is missing or invalid."`	`string`	Die Meldung der Ausnahme. Ohne Angabe wird eine Standardmeldung verwendet.

Rückgabewert

GoogleAppsScript.Spreadsheet.Spreadsheet — denselben Wert, typisiert als eine Tabelle.

Ausnahmen

Ausnahme	Bedingung
`InvalidSpreadsheetException`	der Wert ist nicht eine Tabelle.

Beispiele

Was besteht und was nicht

const spreadsheet = SpreadsheetApp.getActive();

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

Siehe auch

Quellcode

src/appsscript/sheet/requireSpreadsheet.ts

23 September 2026

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