es-toolkit/docs/reference/array/chunk.md
Minsoo Kim cf65b2c601
style(*): Setup prettier and apply formatting (#24)
* chore: add prettierrc

* chore: apply format with prettier config

* chore: eslint error fix
2024-06-04 17:19:26 +09:00

41 lines
1.0 KiB
Markdown

# 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
```typescript
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
```typescript
import { chunk } from 'es-toolkit/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']]
```