group-array
Advanced tools
Readme
Group array of objects into lists.
Please consider following this project's author, Brian Woodward, and consider starring the project to show your :heart: and support.
(TOC generated by verb using markdown-toc)
Install with npm:
$ npm install --save group-array
var groupArray = require('group-array');
var arr = [
{tag: 'one', content: 'A'},
{tag: 'one', content: 'B'},
{tag: 'two', content: 'C'},
{tag: 'two', content: 'D'},
{tag: 'three', content: 'E'},
{tag: 'three', content: 'F'}
];
// group by the `tag` property
groupArray(arr, 'tag');
results in:
{
one: [
{tag: 'one', content: 'A'},
{tag: 'one', content: 'B'}
],
two: [
{tag: 'two', content: 'C'},
{tag: 'two', content: 'D'}
],
three: [
{tag: 'three', content: 'E'},
{tag: 'three', content: 'F'}
]
}
Group by multiple, deeply nested properties
// given an array of object, like blog posts...
var arr = [
{ data: { year: '2016', tag: 'one', month: 'jan', day: '01'}, content: '...'},
{ data: { year: '2016', tag: 'one', month: 'jan', day: '01'}, content: '...'},
{ data: { year: '2016', tag: 'one', month: 'jan', day: '02'}, content: '...'},
{ data: { year: '2016', tag: 'one', month: 'jan', day: '02'}, content: '...'},
{ data: { year: '2016', tag: 'one', month: 'feb', day: '10'}, content: '...'},
{ data: { year: '2016', tag: 'one', month: 'feb', day: '10'}, content: '...'},
{ data: { year: '2016', tag: 'one', month: 'feb', day: '12'}, content: '...'},
{ data: { year: '2016', tag: 'one', month: 'feb', day: '12'}, content: '...'},
{ data: { year: '2016', tag: 'two', month: 'jan', day: '14'}, content: '...'},
{ data: { year: '2016', tag: 'two', month: 'jan', day: '14'}, content: '...'},
{ data: { year: '2016', tag: 'two', month: 'jan', day: '16'}, content: '...'},
{ data: { year: '2016', tag: 'two', month: 'jan', day: '16'}, content: '...'},
{ data: { year: '2016', tag: 'two', month: 'feb', day: '18'}, content: '...'},
{ data: { year: '2017', tag: 'two', month: 'feb', day: '18'}, content: '...'},
{ data: { year: '2017', tag: 'two', month: 'feb', day: '10'}, content: '...'},
{ data: { year: '2017', tag: 'two', month: 'feb', day: '10'}, content: '...'},
{ data: { year: '2017', tag: 'three', month: 'jan', day: '01'}, content: '...'},
{ data: { year: '2017', tag: 'three', month: 'jan', day: '01'}, content: '...'},
{ data: { year: '2017', tag: 'three', month: 'jan', day: '02'}, content: '...'},
{ data: { year: '2017', tag: 'three', month: 'jan', day: '02'}, content: '...'},
{ data: { year: '2017', tag: 'three', month: 'feb', day: '01'}, content: '...'},
{ data: { year: '2017', tag: 'three', month: 'feb', day: '01'}, content: '...'},
{ data: { year: '2017', tag: 'three', month: 'feb', day: '02'}, content: '...'},
{ data: { year: '2017', tag: 'three', month: 'feb', day: '02'}, content: '...'}
]
Pass a list or array of properties:
groupArray(arr, 'data.year', 'data.tag', 'data.month', 'data.day');
Results in something like this: (abbreviated)
{ '2016':
{ one:
{ jan:
{ '01':
[ { data: { year: '2016', tag: 'one', month: 'jan', day: '01' },
content: '...' },
{ data: { year: '2016', tag: 'one', month: 'jan', day: '01' },
content: '...' } ],
'02':
[ { data: { year: '2016', tag: 'one', month: 'jan', day: '02' },
content: '...' },
{ data: { year: '2016', tag: 'one', month: 'jan', day: '02' },
content: '...' } ] },
feb:
{ '10':
[ { data: { year: '2016', tag: 'one', month: 'feb', day: '10' },
content: '...' },
{ data: { year: '2016', tag: 'one', month: 'feb', day: '10' },
content: '...' } ],
'12':
[ { data: { year: '2016', tag: 'one', month: 'feb', day: '12' },
content: '...' },
{ data: { year: '2016', tag: 'one', month: 'feb', day: '12' },
content: '...' } ] } },
two:
{ jan:
{ '14':
[ { data: { year: '2016', tag: 'two', month: 'jan', day: '14' },
content: '...' },
{ data: { year: '2016', tag: 'two', month: 'jan', day: '14' },
content: '...' } ],
'16':
[ { data: { year: '2016', tag: 'two', month: 'jan', day: '16' },
content: '...' },
{ data: { year: '2016', tag: 'two', month: 'jan', day: '16' },
content: '...' } ] },
feb:
{ '18':
[ { data: { year: '2016', tag: 'two', month: 'feb', day: '18' },
content: '...' } ] } } },
'2017':
{ two:
{ feb:
{ '10':
[ { data: { year: '2017', tag: 'two', month: 'feb', day: '10' },
content: '...' },
{ data: { year: '2017', tag: 'two', month: 'feb', day: '10' },
content: '...' } ],
'18':
[ { data: { year: '2017', tag: 'two', month: 'feb', day: '18' },
content: '...' } ] } },
three:
{ jan:
{ '01':
[ { data: { year: '2017', tag: 'three', month: 'jan', day: '01' },
content: '...' },
{ data: { year: '2017', tag: 'three', month: 'jan', day: '01' },
content: '...' } ],
'02':
[ { data: { year: '2017', tag: 'three', month: 'jan', day: '02' },
content: '...' },
{ data: { year: '2017', tag: 'three', month: 'jan', day: '02' },
content: '...' } ] },
feb:
{ '01':
[ { data: { year: '2017', tag: 'three', month: 'feb', day: '01' },
content: '...' },
{ data: { year: '2017', tag: 'three', month: 'feb', day: '01' },
content: '...' } ],
'02':
[ { data: { year: '2017', tag: 'three', month: 'feb', day: '02' },
content: '...' },
{ data: { year: '2017', tag: 'three', month: 'feb', day: '02' },
content: '...' } ] } } } }
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verb
You might also be interested in these projects:
| Commits | Contributor |
|---|---|
| 32 | doowb |
| 13 | jonschlinkert |
| 2 | johlym |
| 1 | cperryk |
Brian Woodward
Copyright © 2019, Brian Woodward. Released under the MIT License.
This file was generated by verb-generate-readme, v0.8.0, on July 22, 2019.
FAQs
Group array of objects into lists.
The npm package group-array receives a total of 74,464 weekly downloads. As such, group-array popularity was classified as popular.
We found that group-array demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Socket CEO Feross Aboukhadijeh joins a16z partners to discuss how modern, sophisticated supply chain attacks require AI-driven defenses and explore the challenges and solutions in leveraging AI for threat detection early in the development life cycle.
Security News
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.