@array-utils/chunk-it

@array-utils/chunk-it

Split any array into chunks.

Usage

chunkIt(arr)

Creates "chunker" for the array arr. Throws an error if arr is not an array.

import { chunkIt } from "@array-utils/chunk-it";

// Creates "chunker"
const chunker = chunkIt([1, 2, 3, 4, 5, 6]);

// Throws an error if arr is not an array
chunkIt("boooooooooom");

chunkIt.count(n, strict = false)

Splits an array into n number of chunks. If strict is set to true, the function will throw an error if there are fewer than n elements in the array.

import { chunkIt } from "@array-utils/chunk-it";

// Splits an array into 5 chunks, array has fewer than 5 elements, default strict => false
const arr1 = [10, 20, 30];
const result1 = chunkIt(arr).count(5); // [[10], [20], [30], [], []]

// Throws an error, array has fewer than 5 elements, strict set to true
const arr2 = [10, 20, 30];
chunkIt(arr2).count(5, true); // throws Error

// Splits an array into 3 chunks, exactly 3 elements in the array, strict set to true
const arr3 = [10, 20, 30];
const result3 = chunkIt(arr3).count(3); // [[10], [20], [30]]

// Splits an array into 3 chunks
const arr4 = [10, 20, 30, 40, 50, 60, 70, 80, 90, 100, 110];
/* [
    [10, 20, 30, 40],
    [50, 60, 70, 80],
    [90, 100, 110],
] */
const result4 = chunkIt(arr4).count(3, true);

chunkIt.size(n)

Splits an array into chunks of length / size n

import { chunkIt } from "@array-utils/chunk-it";

// Splits an array into chunks with max length / size of 3
const arr1 = [10, 20, 30, 40, 50, 60, 70, 80, 90, 100];
const result1 = chunkIt(arr).size(3); // [[10, 20, 30], [40, 50, 60], [70, 80, 90], [100]]