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

77 lines
1.4 KiB
Markdown

# map-obj [![Build Status](https://travis-ci.org/sindresorhus/map-obj.svg?branch=master)](https://travis-ci.org/sindresorhus/map-obj)
> Map object keys and values into a new object
## Install
```
$ npm install map-obj
```
## Usage
```js
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`<br>
Default: `false`
Recurse nested objects and objects in arrays.
##### target
Type: `object`<br>
Default: `{}`
Target object to map properties on to.
## Related
- [filter-obj](https://github.com/sindresorhus/filter-obj) - Filter object keys and values into a new object
---
<div align="center">
<b>
<a href="https://tidelift.com/subscription/pkg/npm-map-obj?utm_source=npm-map-obj&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
</b>
<br>
<sub>
Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
</sub>
</div>