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) на основі вихідного коду бібліотеки.