assign

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

Installation

npm install @stdlib/object-assign

Usage

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.

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

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.

Examples

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' }

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.