@stdlib/object/assign/README.md

Object.

<!--

@license Apache-2.0

Copyright (c) 2023 The Stdlib Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->

# assign

> Copy enumerable own properties from one or more source objects to a target object.

<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

<section class="intro">

</section>

<!-- /.intro -->

<!-- Package usage documentation. -->

<section class="usage">

## Usage

```javascript
var assign = require( '@stdlib/object/assign' );
```

#### assign( target, source1\[, source2\[,...,sourceN]] )

Copies enumerable own properties from one or more source objects to a target object.

```javascript
var x = {
    'a': 'beep'
};
var y = {
    'b': 'boop'
};

var z = assign( x, y );

var v = z.b;
// returns 'boop'

var bool = ( z === x );
// returns true
```

</section>

<!-- /.usage -->

<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="notes">

## Notes

-   If a property key is present in multiple sources, the property from the last source that defines the key prevails.
-   The target object is mutated.

</section>

<!-- /.notes -->

<!-- Package usage examples. -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var assign = require( '@stdlib/object/assign' );

var obj1 = {
    'name': 'Jane',
    'age': 29
};
var obj2 = {
    'country': 'US',
    'city': 'San Francisco'
};
var obj3 = {
    'hobby': 'Reading'
};

var result = assign( obj1, obj2, obj3 );
// returns { 'name': 'Jane', 'age': 29, 'country': 'US', 'city': 'San Francisco', 'hobby': 'Reading' }
```

</section>

<!-- /.examples -->

<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="references">

</section>

<!-- /.references -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

<!-- /.related -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

<!-- <related-links> -->

<!-- </related-links> -->

</section>

<!-- /.links -->