Skip to content

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

License

Notifications You must be signed in to change notification settings

mudssrali/chunkify

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

chunkify

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

JavaScript Style Guide tested with jest

Install

Install with npm or yarn via

yarn add @mudssrali/chunkify

or

npm i @mudssrali/chunkify

API

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

Usage

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

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 [[]]

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