Skip to content

Latest commit

 

History

History
88 lines (61 loc) · 1.12 KB

README.md

File metadata and controls

88 lines (61 loc) · 1.12 KB

MOBIK

Mobik

Fast 273 bytes Array utility for merging an array of objects by a given key.

📦 Installation

npm install mobik --save

🚀 Load

// using es modules
import mobik from 'mobik'

// common.js
const mobik = require('mobik')

Or use script tags and globals.

<script src="https://unpkg.com/mobik"></script>

And then grab it off the global like so:

const mobik = mobik.default;

💡 Usage

Let's assume you want to group a set of objects in an array by key

const newArray = mobik('a', [{a: 1, b: 2}, {c: 3, a: 1}]);

/*
[
  {
    a: 1,
    b: 2,
    c: 3
  }
]
*/

It works with nested objects too!

const newArray = mobik('a', [{a: 1, b: 2}, {c: {d: 4}, a: 1}]);

/*
[
  {
    a: 1,
    b: 2,
    c: {
      d: 4
    }
  }
]
*/

API

mobik(key: String, array: Array) [required]

Returns an Array with a merged Object

OR [] when no key is found.

Tests

npm test

Legal

Released under MIT license.