Function isBoundedLengthTuple

isBoundedLengthTuple<Min extends ArgArr, Max extends ArgArr, E>(
    min: Min,
    max: Max,
    array: readonly E[],
): array is BoundedLengthTuple<Min, Max, E>
Checks if an array's length is within a specific inclusive range.
Type Parameters
- Min extends ArgArr
- Max extends ArgArr
- E
Parameters
- min: Min
- max: Max
- array: readonly E[]
Returns array is BoundedLengthTuple<Min, Max, E>
Example
```
const pair: readonly number[] = [1, 2] as const;

const quad: readonly number[] = [1, 2, 3, 4] as const;

assert.isTrue(Arr.isBoundedLengthTuple(1, 3, pair));

assert.isFalse(Arr.isBoundedLengthTuple(1, 3, quad));

if (Arr.isBoundedLengthTuple(1, 3, pair)) {
  assert.isTrue(pair.length >= 1 && pair.length <= 3);
}
```
- Defined in packages/ts-data-forge/src/array/impl/array-utils-length-bounded-tuple-guard.mts:225
isBoundedLengthTuple<Min extends ArgArr, Max extends ArgArr>(
min: Min,
max: Max,
): <E>(array: readonly E[]) => array is BoundedLengthTuple<Min, Max, E>
Checks if an array's length is within a specific inclusive range.
Type Parameters
- Min extends ArgArr
- Max extends ArgArr
Parameters
- min: Min
- max: Max
Returns <E>(array: readonly E[]) => array is BoundedLengthTuple<Min, Max, E>
Example
```
const pair: readonly number[] = [1, 2] as const;

const quad: readonly number[] = [1, 2, 3, 4] as const;

assert.isTrue(Arr.isBoundedLengthTuple(1, 3, pair));

assert.isFalse(Arr.isBoundedLengthTuple(1, 3, quad));

if (Arr.isBoundedLengthTuple(1, 3, pair)) {
  assert.isTrue(pair.length >= 1 && pair.length <= 3);
}
```
- Defined in packages/ts-data-forge/src/array/impl/array-utils-length-bounded-tuple-guard.mts:236

Function isBoundedLengthTuple

Type Parameters

Parameters

Returns array is BoundedLengthTuple<Min, Max, E>

Example

Type Parameters

Parameters

Returns <E>(array: readonly E[]) => array is BoundedLengthTuple<Min, Max, E>

Example

Settings