https://github.com/mudssrali/chunkify

a simple utility to split given array into chunks of input size with array reverse option
https://github.com/mudssrali/chunkify

array array-splitter chunk chunking-algorithm chunking-array javascript split typescript

Last synced: 3 days ago
JSON representation

a simple utility to split given array into chunks of input size with array reverse option

• Host: GitHub
• URL: https://github.com/mudssrali/chunkify
• Owner: mudssrali
• License: mit
• Created: 2021-04-24T10:25:42.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-04-25T18:14:01.000Z (over 3 years ago)
• Last Synced: 2024-11-06T08:44:39.688Z (8 days ago)
• Topics: array, array-splitter, chunk, chunking-algorithm, chunking-array, javascript, split, typescript
• Language: TypeScript
• Homepage:
• Size: 105 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# chunkify

A simple utility to split given array into chunks of input size with array reverse option

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

[![tested with jest](https://img.shields.io/badge/tested_with-jest-99424f.svg)](https://github.com/facebook/jest)



  



## Install

Install with npm or yarn via

```

yarn add @mudssrali/chunkify

```

or

```

npm i @mudssrali/chunkify

```

## API

```ts

 const chunkify: (kvArray: T[], chunkSize: number, reverse?: boolean) => T[][];

```

## Usage

```js

import chunkify from '@mudssrali/chunkify'

const value = chunkify([1,2,3,4], 2)

// value === [[1, 2], [3, 4]]

```

You can also pass reverse option as third argument to reverse the order of array element while creating chunks

```js

import chunkify from '@mudssrali/chunkify'

const value = chunkify(["open-source", "is", "everything"], 1, true)

// value === [["everything"], ["is"], ["open-source"]]

```

Also keep in mind, if the `chunkSize is >= kvArray.length`, return value will be in form of `[[]]`

```jsx

import chunkify from '@mudssrali/chunkify'

const value = chunkify([1,2,3,4], 4)

// value === [ [1, 2, 3, 4] ]

// value === [ [4, 3, 2, 1] ] // true passed as third argument to chunkify

```