ts-array-length

TypeScript utilities for dealing with array length. Of course, type predicates inside.

Useful for codebase with noUncheckedIndexedAccess turned on.

Installation

``
npm i -D ts-array-length
`

API: functions

$3

Returns true if arr.length === len.

#### Example

`ts
// const arr: string[]

if (hasLength(arr, 1)) {
// arr: readonly [string]
const str: string = arr[0];
}
`

$3

Returns true if arr.length >= len.

#### Example

`ts
// const arr: string[]

if (hasMinLength(arr, 1)) {
// arr: readonly [string, ...string[]]
const str: string = arr[0];
}
`

$3

Returns true if arr.length >= 1.

#### Example

`ts
// const arr: string[]

if (isNonEmpty(arr)) {
// arr: readonly [string, ...string[]]
const str: string = arr[0];
}
`

API: utility types

$3

Tuple type whose element type is T and has exact length N.

`ts
// readonly [string, string, string]
type SSS = ReadonlyArrayExactLength;
`

$3

Tuple type whose element type is T and has at least N elements.

`ts
// readonly [string, string, string, ...string[]]
type SSS = ReadonlyArrayMinLength;
``

License

MIT