action-debian-package/node_modules/map-obj/readme.md
Dawid Dziurla 9308795b8b
update
2020-03-26 15:37:35 +01:00

1.4 KiB

map-obj Build Status

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'}

API

mapObject(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.

  • filter-obj - Filter object keys and values into a new object

Get professional support for this package with a Tidelift subscription
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.