tree: 18ebc851a59c84adb3df1cd847e243b17fa7e420 [path history] [tgz]
  1. index.d.ts
  2. index.js
  3. license
  4. package.json
  5. readme.md
node_modules/map-obj/readme.md

map-obj

Map object keys and values into a new object

Install

$ npm install map-obj

Usage

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

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

const newObject = mapObject({FOO: true, bAr: {bAz: true}}, (key, value) => [key.toLowerCase(), value]);
//=> {foo: true, bar: {bAz: true}}

const newObject = mapObject({FOO: true, bAr: {bAz: true}}, (key, value) => [key.toLowerCase(), value], {deep: true});
//=> {foo: true, bar: {baz: true}}

API

mapObject(source, mapper, options?)

source

Type: object

Source object to copy properties from.

mapper

Type: (sourceKey, sourceValue, source) => [targetKey, targetValue, mapperOptions?]

Mapping function.

mapperOptions
shouldRecurse

Type: boolean
Default: true

Whether targetValue should be recursed. Requires deep: true.

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