chunk

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.

Signature

function chunk<T>(arr: T[], size: number): T[][];

Parameters

• arr (T[]): The array to be chunked into smaller arrays.
• size (number): 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

Throws an error if size is not a positive integer.

Examples

import { chunk } from 'js-utils-es/array';

// Splits an array of numbers into sub-arrays of length 2
chunk([1, 2, 3, 4, 5], 2);
// Returns: [[1, 2], [3, 4], [5]]

// 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']]

Lodash Compatibility

Import chunk from js-utils-es/compat for full compatibility with lodash.

• chunk does not throw when size less than one is given.
• chunk accepts fractional values, which are rounded down to the nearest integer.

import { chunk } from 'js-utils-es/compat';

chunk([1, 2, 3], 0); // Returns []

Source

Source • Docs • Test Case

Contributors

Hung Hoang

Changelog

v1.0.6 on 7/15/2024

493fe - docs: update