requireCountable

function requireCountable(
  value: unknown,
  message: string = "Expected a non-negative safe integer."
): number;

Значение, годное как количество, длина или индекс с нуля: целое, неотрицательное и достаточно малое, чтобы арифметика над ним оставалась точной.

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

Параметры

Параметр	Тип	Описание
`value`	`unknown`	Значение, которое нужно проверить.
`message` (необязательный) `= "Expected a non-negative safe integer."`	`string`	Сообщение исключения. Если не задано, используется сообщение по умолчанию.

Возвращает

number — то же значение, уже проверенное как счётное число.

Исключения

Исключение	Условие
`IllegalArgumentException`	значение не является счётным числом.

Примеры

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

requireCountable(0); // => 0
requireCountable(42); // => 42
requireCountable(-1); // throws IllegalArgumentException
requireCountable(1.5); // throws IllegalArgumentException

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

Исходный код

src/lang/number/requireCountable.ts

23 September 2026

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