requireRange

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

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() === "Range". 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.Range — denselben Wert, typisiert als einen Bereich.

Ausnahmen

Ausnahme	Bedingung
`InvalidRangeException`	der Wert ist nicht ein Bereich.

Beispiele

Was besteht und was nicht

const range = SpreadsheetApp.getActiveRange();

requireRange(range); // => range
requireRange({}); // throws InvalidRangeException
requireRange(null); // throws InvalidRangeException

Siehe auch

Quellcode

src/appsscript/sheet/requireRange.ts

23 September 2026

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