https://github.com/lirantal/array-to-objecthash

Converts an Array to an Object Hash based on specified object key
https://github.com/lirantal/array-to-objecthash

hashmap nodejs utility

Last synced: 13 days ago
JSON representation

Converts an Array to an Object Hash based on specified object key

• Host: GitHub
• URL: https://github.com/lirantal/array-to-objecthash
• Owner: lirantal
• License: mit
• Created: 2017-02-02T08:52:17.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-11-25T11:41:29.000Z (about 7 years ago)
• Last Synced: 2024-12-12T20:12:45.143Z (2 months ago)
• Topics: hashmap, nodejs, utility
• Language: JavaScript
• Size: 40 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Array to Object

Converts an Array of objects to an Object hash

## Why?

It's useful when you have an array of objects which you wish to normalize into a single object that can be easily accessed using O(1) hash map.

## Installation

Bold people do:

```bash

yarn add array-to-objecthash

```

The rest can use the mundane:

```bash

npm install --save array-to-objecthash

```

## Usage

If you have the following array of objects:

```js

  const arr = [

    {

      key: 'key_one',

      value: 'some value one'

    },

    {

      key: 'key_two',

      value: 'some value two'

    }

  ]

```

You can convert it to an Object hash based on a key of your choosing in the top level object

```js

  const convertArrayToHash = require('array-to-objecthash')

  const obj = convertArrayToHash(arr, 'key')

```

The result is:

```js

{ 

  key_one: { key: 'key_one', value: 'some value one' },

  key_two: { key: 'key_two', value: 'some value two' }

}

```

  

## Tests

Project tests:

```bash

npm run test

```

Project linting:

```bash

npm run lint

```

## Coverage

```bash

npm run test:coverage

```

## Commit

The project uses the commitizen tool for standardizing changelog style commit

messages so you should follow it as so:

```bash

git add .           # add files to staging

npm run commit      # use the wizard for the commit message

```