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

requireArray

function requireArray<T>(value: unknown, message: string = "Expected an array."): T[];

Проверка целиком сводится к Array.isArray, поэтому массив из другого фрейма подходит, а похожий на массив объект — arguments, NodeList, { length: 0 } — нет.

isX и nonX отвечают на вопрос и никогда не прерывают выполнение; requireX и requireNonX возвращают значение или выбрасывают исключение. Схема разобрана в Соглашения о проверках.

Параметры

Параметр

Тип

Описание

value

unknown

Значение, которое нужно проверить.

message (необязательный) = "Expected an array."

string

Сообщение исключения. Если не задано, используется сообщение по умолчанию.

Возвращает

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

Исключения

Исключение

Условие

IllegalArgumentException

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

Примеры

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

requireArray([]); // => [] requireArray([1, 2, 3]); // => [1, 2, 3] requireArray("abc"); // throws IllegalArgumentException requireArray({ length: 0 }); // throws IllegalArgumentException

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

Исходный код

src/lang/base/requireArray.ts

23 September 2026

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