apps-script-utils (Русский) 2.1.1 Help

require2DArray

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

Проверка, которую ставят перед Range#setValues: тот отвергает плоский массив сообщением, не называющим ни аргумент, ни причину. require2DArray выбрасывает исключение раньше, с вашим сообщением, и возвращает значение, поэтому вызов встраивается в выражение.

Принимается ровно то же, что принимает is2DArray: непустой массив, каждый элемент которого — массив. Строки разной длины проходят; когда они должны совпадать, берите requireConsistent2DArray.

Параметры

Параметр

Тип

Описание

value

unknown

Проверяемое значение.

message (необязательный) = "Expected a non-empty two-dimensional array."

string

Сообщение исключения. По умолчанию "Expected a non-empty two-dimensional array."

Возвращает

T[][] — то же значение с типом двумерного массива.

Исключения

Исключение

Условие

IllegalArgumentException

значение не является непустым массивом массивов.

Примеры

Проверка и использование в одном выражении

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

Что проходит, а что нет

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

Смотрите также

Исходный код

src/lang/array/require2DArray.ts

23 September 2026

Эта документация сгенерирована нейросетью (Claude) на основе исходного кода библиотеки.