array-groupby

0.1.0 • Public • Published

array-groupby

Curried function that returns a map (object) with keys derived by applying each array element to the given identity function. The value(s) at each key will be an array of elements whose identity matches the given key.

Build Status Code Climate js-standard-style

npm install array-groupby --save

You can also use Duo, Bower or download the files manually.

npm stats

npm NPM downloads David

API Example

Dot-notation object access
var groupBy = require('array-groupby')
var strings = [ 'two', 'birds', 'three', 'green', 'peas' ]
 
groupBy('length', strings)
//=> { '3': [ 'two' ], '4': [ 'peas' ], '5': [ 'birds', 'three', 'green' ] }
Pointfree Style
var groupBy = require('array-groupby')
var strings = Promise.resolve([ 'two', 'birds', 'three', 'green', 'peas' ])
var charAt0 = string => string[0]
 
strings.then(groupBy(charAt0))
//=> { t: [ 'two', 'three' ], b: [ 'birds' ], g: [ 'green' ], p: [ 'peas' ] }

API

groupBy(fn, list)

arguments
  • fn (Function|String) Function to apply to each element.
  • list (array) Array to evaluate.
returns
  • (Object) Object with keys derived by applying each array element to the given identity function.

Contributing

SEE: contributing.md

Licenses

GitHub license

Package Sidebar

Install

npm i array-groupby

Weekly Downloads

32

Version

0.1.0

License

MIT

Last publish

Collaborators

  • wilmoore