@technobuddha/library/src/create2d-array.ts

A large library of useful functions

import { isFunction } from './is-function.ts';

/**
 * Create a two dimensional array with all elements initialized
 * @remarks Array is accessed by
 * ```js
 * array[w][h]
 * ```
 * @example
 * ```typescript
 * create2DArray(2, 3, 0);  // [[0, 0, 0], [0, 0, 0]]
 *
 * create2DArray(2, 3, (x, y) => x + y); // [[0, 1, 2], [1, 2, 3]]
 * ```
 * @typeParam T - Type of the elements in the array
 * @param width - Width of the array
 * @param height - Height of the array
 * @param fill - Value to fill the array, or a function returning the fill value for each element
 * @group Array
 * @category Construction
 */
export function create2dArray<T>(
  width: number,
  height: number,
  fill: T | ((this: void, x: number, y: number) => T),
): T[][] {
  if (isFunction(fill)) {
    return Array.from(Array.from({ length: width }), (_1, x) =>
      Array.from(Array.from({ length: height }), (_2, y) => fill(x, y)),
    );
  }

  return Array.from(Array.from({ length: width }), () =>
    Array.from({ length: height }).fill(fill),
  ) as T[][];
}