38 lines
1.4 KiB
JavaScript
38 lines
1.4 KiB
JavaScript
|
//#region src/array/chunk.ts
|
||
|
|
/**
|
||
|
|
* Splits an array into smaller arrays of a specified length.
|
||
|
|
*
|
||
|
|
* This function takes an input array and divides it into multiple smaller arrays,
|
||
|
|
* each of a specified length. If the input array cannot be evenly divided,
|
||
|
|
* the final sub-array will contain the remaining elements.
|
||
|
|
*
|
||
|
|
* @template T The type of elements in the array.
|
||
|
|
* @param {T[]} arr - The array to be chunked into smaller arrays.
|
||
|
|
* @param {number} size - The size of each smaller array. Must be a positive integer.
|
||
|
|
* @returns {T[][]} A two-dimensional array where each sub-array has a maximum length of `size`.
|
||
|
|
* @throws {Error} Throws an error if `size` is not a positive integer.
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Splits an array of numbers into sub-arrays of length 2
|
||
|
|
* chunk([1, 2, 3, 4, 5], 2);
|
||
|
|
* // Returns: [[1, 2], [3, 4], [5]]
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Splits an array of strings into sub-arrays of length 3
|
||
|
|
* chunk(['a', 'b', 'c', 'd', 'e', 'f', 'g'], 3);
|
||
|
|
* // Returns: [['a', 'b', 'c'], ['d', 'e', 'f'], ['g']]
|
||
|
|
*/
|
||
|
|
function chunk(arr, size) {
|
||
|
|
if (!Number.isInteger(size) || size <= 0) throw new Error("Size must be an integer greater than zero.");
|
||
|
|
const chunkLength = Math.ceil(arr.length / size);
|
||
|
|
const result = Array(chunkLength);
|
||
|
|
for (let index = 0; index < chunkLength; index++) {
|
||
|
|
const start = index * size;
|
||
|
|
const end = start + size;
|
||
|
|
result[index] = arr.slice(start, end);
|
||
|
|
}
|
||
|
|
return result;
|
||
|
|
}
|
||
|
|
//#endregion
|
||
|
|
export { chunk };
|