wishthis/node_modules/object-assign/readme.md

52 lines
1.2 KiB
Markdown
Raw Normal View History

2022-01-21 08:28:41 +00:00
# object-assign [![Build Status](https://travis-ci.org/sindresorhus/object-assign.svg?branch=master)](https://travis-ci.org/sindresorhus/object-assign)
2023-08-17 09:47:40 +00:00
> ES6 [`Object.assign()`](http://www.2ality.com/2014/01/object-assign.html) ponyfill
2022-01-21 08:28:41 +00:00
2023-08-17 09:47:40 +00:00
> Ponyfill: A polyfill that doesn't overwrite the native method
2022-01-21 08:28:41 +00:00
## Install
2023-08-17 09:47:40 +00:00
```sh
2022-01-21 08:28:41 +00:00
$ npm install --save object-assign
```
## Usage
```js
2023-08-17 09:47:40 +00:00
var objectAssign = require('object-assign');
2022-01-21 08:28:41 +00:00
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
2023-08-17 09:47:40 +00:00
### objectAssign(target, source, [source, ...])
2022-01-21 08:28:41 +00:00
Assigns enumerable own properties of `source` objects to the `target` object and returns the `target` object. Additional `source` objects will overwrite previous ones.
## Resources
2023-08-17 09:47:40 +00:00
- [ES6 spec - Object.assign](https://people.mozilla.org/~jorendorff/es6-draft.html#sec-object.assign)
2022-01-21 08:28:41 +00:00
## License
2023-08-17 09:47:40 +00:00
MIT © [Sindre Sorhus](http://sindresorhus.com)