es-toolkit/dist/fp/array/chunk.mjs

A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.

import { chunk as chunk$1 } from "../../array/chunk.mjs";
//#region src/fp/array/chunk.ts
/**
* Creates a function that splits an array into sub-arrays of length `size`. The
* final chunk holds the remaining elements when the array cannot be divided
* evenly. Use it with {@link pipe}.
*
* @template T - The type of elements in the array.
* @param size - The length of each chunk. Must be a positive integer.
* @returns A function that maps a `readonly T[]` to a `T[][]`.
* @throws {Error} When `size` is not a positive integer (propagated from the underlying implementation).
*
* @example
* import { pipe, chunk } from 'es-toolkit/fp';
*
* pipe([1, 2, 3, 4, 5], chunk(2)); // => [[1, 2], [3, 4], [5]]
*/
function chunk(size) {
	return function(array) {
		return chunk$1(array, size);
	};
}
//#endregion
export { chunk };