chunk

配列を指定されたサイズの小さな配列に分割し、新しい2次元配列を返します。

const chunked = chunk(arr, size);

参照

chunk(arr, size)

長い配列を同じサイズの複数の小さな配列に分割したい場合は chunk を使用してください。配列を均等に分割できない場合、最後の配列に残りの要素が含まれます。

import { chunk } from 'es-toolkit/array';

// 数値配列をサイズ2に分割します。
chunk([1, 2, 3, 4, 5], 2);
// Returns: [[1, 2], [3, 4], [5]]

// 文字列配列をサイズ3に分割します。
chunk(['a', 'b', 'c', 'd', 'e', 'f', 'g'], 3);
// Returns: [['a', 'b', 'c'], ['d', 'e', 'f'], ['g']]

空の配列を分割すると空の配列が返されます。

import { chunk } from 'es-toolkit/array';

chunk([], 2); // []

パラメータ

• arr (T[]): 分割する配列です。
• size (number): 各小さな配列のサイズです。正の整数である必要があります。

戻り値

(T[][]): サイズ size に分割された2次元配列を返します。

エラー

size が正の整数でない場合、エラーをスローします。

使用例

import "./styles.css";

document.getElementById("app").innerHTML = `
<h1>Hello world</h1>
`;

Open Sandbox

Lodash 互換性

es-toolkit/compat から chunk をインポートすると、Lodash と互換になります。

• size が 1 未満の場合、空の配列を返します。
• size に小数点のある数を提供しても、整数に切り捨てられます。

import { chunk } from 'es-toolkit/compat';

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

性能比較

	バンドルサイズ	ランタイム性能
es-toolkit	238 バイト (92.4% 小さい)	9,338,821 回 (11% 遅い)
es-toolkit/compat	307 バイト (90.2% 小さい)	9,892,157 回 (5% 遅い)
lodash-es	3,153 バイト	10,523,270 回