require2DArray

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

La vérification à placer devant Range#setValues, qui rejette un tableau plat avec un message ne nommant ni l'argument ni la raison. require2DArray lève avant, avec le message de votre choix, et renvoie la valeur : l'appel s'insère donc dans une expression.

Il accepte exactement ce qu'accepte is2DArray: un tableau non vide dont chaque élément est un tableau. Des lignes de longueurs différentes passent ; lorsqu'elles doivent correspondre, utilisez requireConsistent2DArray.

Paramètres

Paramètre	Type	Description
`value`	`unknown`	La valeur à valider.
`message` (facultatif) `= "Expected a non-empty two-dimensional array."`	`string`	Le message de l'exception. Par défaut `"Expected a non-empty two-dimensional array."`

Valeur de retour

T[][] — la même valeur, typée comme tableau bidimensionnel.

Exceptions

Exception	Condition
`IllegalArgumentException`	la valeur n'est pas un tableau non vide de tableaux.

Exemples

Valider et utiliser dans une seule expression

/**
 * 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);
}

Ce qui passe et ce qui lève

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

Voir aussi

is2DArray — la même vérification sous forme de prédicat.
non2DArray — le prédicat nié.
requireConsistent2DArray — exige en plus des lignes de même longueur.
Utilitaires de base

Code source

src/lang/array/require2DArray.ts

23 September 2026

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