array-to-objecthash v1.0.1

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:

yarn add array-to-objecthash

The rest can use the mundane:

npm install --save array-to-objecthash

Usage

If you have the following array of objects:

  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

  const convertArrayToHash = require('array-to-objecthash')
  const obj = convertArrayToHash(arr, 'key')

The result is:

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

Tests

Project tests:

npm run test

Project linting:

npm run lint

Coverage

npm run test:coverage

Commit

The project uses the commitizen tool for standardizing changelog style commit messages so you should follow it as so:

git add .           # add files to staging
npm run commit      # use the wizard for the commit message