require2DArray

function require2DArray<T>(
  value: unknown,
  message: string = "Expected a non-empty two-dimensional array."
): T[][];

Die Prüfung, die vor Range#setValues gehört: das lehnt ein flaches Array mit einer Meldung ab, die weder das Argument noch den Grund nennt. require2DArray wirft vorher, mit einer Meldung Ihrer Wahl, und gibt den Wert zurück, sodass sich der Aufruf in einen Ausdruck einfügt.

Akzeptiert wird genau das, was is2DArray akzeptiert: ein nicht-leeres Array, dessen Elemente alle Arrays sind. Unterschiedlich lange Zeilen bestehen die Prüfung; müssen sie übereinstimmen, nehmen Sie requireConsistent2DArray.

Parameter

Parameter	Typ	Beschreibung
`value`	`unknown`	Der zu prüfende Wert.
`message` (optional) `= "Expected a non-empty two-dimensional array."`	`string`	Die Meldung der Ausnahme. Standard: `"Expected a non-empty two-dimensional array."`

Rückgabewert

T[][] — denselben Wert, typisiert als zweidimensionales Array.

Ausnahmen

Ausnahme	Bedingung
`IllegalArgumentException`	der Wert ist kein nicht-leeres Array aus Arrays.

Beispiele

Prüfen und im selben Ausdruck verwenden

/**
 * Validates the argument at the boundary of the function, with a message that
 * names the argument, and uses the validated value in the same expression.
 */
export function writeRows(sheet: GoogleAppsScript.Spreadsheet.Sheet, values: unknown): void {
  const rows = require2DArray<string>(values, "values must be a matrix of rows");

  sheet.getRange(1, 1, rows.length, rows[0].length).setValues(rows);
}

function writeRows(sheet, values) {
  const rows = require2DArray(values, "values must be a matrix of rows");
  sheet.getRange(1, 1, rows.length, rows[0].length).setValues(rows);
}

Was besteht und was wirft

require2DArray([
  [1, 2],
  [3, 4]
]); // => [[1, 2], [3, 4]]
require2DArray([1, 2]); // throws IllegalArgumentException
require2DArray([]); // throws IllegalArgumentException — no rows

Siehe auch

is2DArray — dieselbe Prüfung als Prädikat.
non2DArray — das verneinte Prädikat.
requireConsistent2DArray — verlangt zusätzlich gleiche Zeilenlängen.
Basis-Werkzeuge

Quellcode

src/lang/array/require2DArray.ts

23 September 2026

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