forked from PirateCare/Syllabus
62 lines
1.5 KiB
Markdown
62 lines
1.5 KiB
Markdown
|
# object-assign [](https://travis-ci.org/sindresorhus/object-assign)
|
||
|
|
|
||
|
|
> ES2015 [`Object.assign()`](http://www.2ality.com/2014/01/object-assign.html) [ponyfill](https://ponyfill.com)
|
||
|
|
|
||
|
|
|
||
|
|
## Use the built-in
|
||
|
|
|
||
|
|
Node.js 4 and up, as well as every evergreen browser (Chrome, Edge, Firefox, Opera, Safari),
|
||
|
|
support `Object.assign()` :tada:. If you target only those environments, then by all
|
||
|
|
means, use `Object.assign()` instead of this package.
|
||
|
|
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
```
|
||
|
|
$ npm install --save object-assign
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```js
|
||
|
|
const objectAssign = require('object-assign');
|
||
|
|
|
||
|
|
objectAssign({foo: 0}, {bar: 1});
|
||
|
|
//=> {foo: 0, bar: 1}
|
||
|
|
|
||
|
|
// multiple sources
|
||
|
|
objectAssign({foo: 0}, {bar: 1}, {baz: 2});
|
||
|
|
//=> {foo: 0, bar: 1, baz: 2}
|
||
|
|
|
||
|
|
// overwrites equal keys
|
||
|
|
objectAssign({foo: 0}, {foo: 1}, {foo: 2});
|
||
|
|
//=> {foo: 2}
|
||
|
|
|
||
|
|
// ignores null and undefined sources
|
||
|
|
objectAssign({foo: 0}, null, {bar: 1}, undefined);
|
||
|
|
//=> {foo: 0, bar: 1}
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## API
|
||
|
|
|
||
|
|
### objectAssign(target, [source, ...])
|
||
|
|
|
||
|
|
Assigns enumerable own properties of `source` objects to the `target` object and returns the `target` object. Additional `source` objects will overwrite previous ones.
|
||
|
|
|
||
|
|
|
||
|
|
## Resources
|
||
|
|
|
||
|
|
- [ES2015 spec - Object.assign](https://people.mozilla.org/~jorendorff/es6-draft.html#sec-object.assign)
|
||
|
|
|
||
|
|
|
||
|
|
## Related
|
||
|
|
|
||
|
|
- [deep-assign](https://github.com/sindresorhus/deep-assign) - Recursive `Object.assign()`
|
||
|
|
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
MIT © [Sindre Sorhus](https://sindresorhus.com)
|