Sha256: 9ce0473b0fbaf7287afb01b6a91bd38f73a31093e59ee86de1fd3f352f3fc817
Contents?: true
Size: 1.31 KB
Versions: 28
Compression:
Stored size: 1.31 KB
Contents
import type {Subtract} from './subtract';
import type {IsEqual} from './is-equal';
type Recursive<T> = Array<Recursive<T>>;
/**
Creates a type that represents a multidimensional array of the given type and dimension.
Use-cases:
- Return a n-dimensional array from functions.
- Declare a n-dimensional array by defining its dimensions rather than declaring `[]` repetitively.
- Infer the dimensions of a n-dimensional array automatically from function arguments.
- Avoid the need to know in advance the dimensions of a n-dimensional array allowing them to be dynamic.
@example
```
import type {MultidimensionalArray} from 'type-fest';
function emptyMatrix<T extends number>(dimensions: T): MultidimensionalArray<unknown, T> {
const matrix: unknown[] = [];
let subMatrix = matrix;
for (let dimension = 1; dimension < dimensions; ++dimension) {
console.log(`Initializing dimension #${dimension}`);
subMatrix[0] = [];
subMatrix = subMatrix[0] as unknown[];
}
return matrix as MultidimensionalArray<unknown, T>;
}
const matrix = emptyMatrix(3);
matrix[0][0][0] = 42;
```
@category Array
*/
export type MultidimensionalArray<Element, Dimensions extends number> = number extends Dimensions
? Recursive<Element>
: IsEqual<Dimensions, 0> extends true
? Element
: Array<MultidimensionalArray<Element, Subtract<Dimensions, 1>>>;
Version data entries
28 entries across 28 versions & 2 rubygems