47 lines
1.5 KiB
Markdown
47 lines
1.5 KiB
Markdown
# pick-by-alias [](http://github.com/badges/stability-badges)
|
||
|
||
Pick object properties by synonyms. Useful to avoid remembering exact option names from user perspective.
|
||
|
||
[](https://npmjs.org/package/pick-by-alias/)
|
||
|
||
```js
|
||
let pick = require('pick-by-alias')
|
||
|
||
let result = pick({
|
||
positions: [...],
|
||
color: 'rgba(0, 100, 200, .75)',
|
||
viewBox: null,
|
||
extra: 123
|
||
}, {
|
||
positions: 'positions points data coordinates',
|
||
color: 'colors color stroke',
|
||
viewport: 'viewport viewBox'
|
||
})
|
||
```
|
||
|
||
### `pick(object, properties, keepRest=false)`
|
||
|
||
Return an object with properties picked by the list or dict with aliases. Aliases are matched in priority order, ie. first matching name is picked. Each alias can be an array or a comma/space-separated string.
|
||
|
||
```js
|
||
// pick by dict
|
||
let {a, b} = pick(src, {a: ['a', 'b', 'c'], b: 'd e f'})
|
||
|
||
// pick by list
|
||
let {c, d, e} = pick(src, ['c', 'd', 'e'])
|
||
|
||
// pick by string
|
||
let {f, g} = pick(src, 'f g')
|
||
```
|
||
|
||
`keepRest` defines if not listed object properties should be transfered to resulting object or discarded.
|
||
|
||
## Related
|
||
|
||
* [defined](https://www.npmjs.com/package/defined) − get first non-undefined out of a list of values
|
||
* [update-diff](https://github.com/dfcreative/update-diff) − update object state by mapping diff.
|
||
|
||
## License
|
||
|
||
(c) 2017 Dima Yv. MIT License
|