@atomic-app/map-obj

Browser-friendly fork of sindresorhus/map-obj

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
10May 2, 2017May 1, 2017Minified + gzip package size for @atomic-app/map-obj in KB

Readme

map-obj Build Status

Map object keys and values into a new object

Note: This is a browser-friendly fork of sindresorhus/map-obj.

Install

$ npm install --save map-obj

Usage

const mapObj = require('map-obj');

const newObject = mapObj({foo: 'bar'}, (key, value) => [value, key]);
//=> {bar: 'foo'}

API

mapObj(source, mapper, [options])

source

Type: Object

Source object to copy properties from.

mapper

Type: Function

Mapping function.

  • It has signature mapper(sourceKey, sourceValue, source).
  • It must return a two item array: [targetKey, targetValue].

options

Type: Object

deep

Type: boolean
Default: false

Recurse nested objects and objects in arrays.

target

Type: Object
Default: {}

Target object to map properties on to.

Related

  • filter-obj - Filter object keys and values into a new object
  • object-assign - Copy enumerable own properties from one or more source objects to a target object

License

MIT © Sindre Sorhus

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.