Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gastonpereyra/map-items-by-keys
Create a dictonary-like object from a list of objects using an specfic value from each object
https://github.com/gastonpereyra/map-items-by-keys
keys list node object
Last synced: 8 days ago
JSON representation
Create a dictonary-like object from a list of objects using an specfic value from each object
- Host: GitHub
- URL: https://github.com/gastonpereyra/map-items-by-keys
- Owner: gastonpereyra
- License: mit
- Created: 2020-09-27T21:52:28.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-09-23T03:53:02.000Z (about 3 years ago)
- Last Synced: 2024-10-31T18:06:40.263Z (15 days ago)
- Topics: keys, list, node, object
- Language: JavaScript
- Homepage:
- Size: 49.8 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Map Items by Keys
## Code Quality Status
[](https://coveralls.io/r/gastonpereyra/map-items-by-keys?branch=master)
## Description
Create a dictonary-like object from a list of objects using an specfic value from each object.
## Installation
```
npm i map-items-by-keys
```
## mapItemsBy(keys, items, isUnique)
### Parameters
#### keys
The name of the fields to use as Keys. Can be a Single Key or Multiple ones.
- Type: _string_ or _Array of string_
- Example:
- `'id'`
- `['id', 'name']`
> :warning: If some item hasn't the field will be ignored
#### items
The list of items to be mapped.
- Type: _Array of objects_
- Example:
```json
[
{ "id": 1, "name": "Bruce Wayne", "hero": "Batman" },
{ "id": 2, "name": "Tony Stark", "hero": "Ironman" }
]
```
#### isUnique
This refers if the values of the keys are unique. This indicate if the final map will save as an array (`false`) or an object (`false`).
- Type: _Boolean_
- Default: `true`
### Examples
#### Single and Unique Key
```js
const mapItemsBy = require('map-items-by-keys');
const items = [
{ id: 1, name: "Bruce Wayne", hero: "Batman" },
{ id: 2, name: "Tony Stark", hero: "Ironman" }
]
const itemsMapped = mapItemsBy("id", items);
/*
output:
{
1: { id: 1, name: "Bruce Wayne", hero: "Batman" },
2: { id: 2, name: "Tony Stark", hero: "Ironman" }
}
*/
```
#### Single and not-unique Key
```js
const mapItemsBy = require('map-items-by-keys');
const items = [
{ id: 1, name: "Bruce Wayne", hero: "Batman" },
{ id: 2, name: "Tony Stark", hero: "Ironman" },
{ id: 3, name: "Richard Grayson", hero: "Batman" }
]
const itemsMapped = mapItemsBy("hero", items, false);
/*
output:
{
Batman: [
{ id: 1, name: Bruce Wayne, hero: "Batman" },
{ id: 3, name: "Richard Grayson", hero: "Batman" }
],
Ironman: [
{ id: 2, name: Tony Stark, hero: "Ironman" }
]
}
*/
```
#### Multiple and Unique Key
```js
const mapItemsBy = require('map-items-by-keys');
const items = [
{ id: 1, name: "Bruce Wayne", hero: "Batman", brand: "DC" },
{ id: 2, name: "Tony Stark", hero: "Ironman", brand: "Marvel" }
]
const itemsMapped = mapItemsBy(["brand", "id"], items);
/*
output:
{
DC: {
1: { id: 1, name: "Bruce Wayne", hero: "Batman" }
},
Marvel: {
2: { id: 2, name: "Tony Stark", hero: "Ironman" }
}
}
*/
```
#### Multiple and not-unique Key
```js
const mapItemsBy = require('map-items-by-keys');
const items = [
{ id: 1, name: "Bruce Wayne", hero: "Batman", brand: "DC" },
{ id: 2, name: "Tony Stark", hero: "Ironman", brand: "Marvel" },
{ id: 3, name: "Richard Grayson", hero: "Batman", brand: "DC" }
]
const itemsMapped = mapItemsBy(["brand", "hero"], items, false);
/*
output:
{
DC: {
Batman: [
{ id: 1, name: "Bruce Wayne", hero: "Batman" },
{ id: 3, name: "Richard Grayson", hero: "Batman", brand: "DC" }
]
},
Marvel: {
Ironman: [
{ id: 2, name: "Tony Stark", hero: "Ironman" }
]
}
}
*/
```
## Bug :bug:
[Report Here](https://github.com/gastonpereyra/map-items-by-keys/issues/new?assignees=gastonpereyra&labels=bug&template=bug.md&title=[BUG])
## Idea :bulb:
[Tell me](https://github.com/gastonpereyra/map-items-by-keys/issues/new?assignees=gastonpereyra&labels=enhancement&title=%5BIDEA%5D+-)