About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
Move Property
Move a property from one object to another object.
Installation
npm install @stdlib/utils-move-property
Usage
var moveProperty = require( '@stdlib/utils-move-property' );
moveProperty( source, prop, target )
Moves a property from one object
to another object
.
var obj1 = {
'a': 'b'
};
var obj2 = {};
var bool = moveProperty( obj1, 'a', obj2 );
// returns true
If the operation is successful, the function returns true
; otherwise, false
.
var obj1 = {
'a': 'b'
};
var obj2 = {};
var bool = moveProperty( obj1, 'c', obj2 );
// returns false
Notes
-
A transfer is shallow.
var arr = [ 1, 2, 3 ]; var obj1 = { 'a': arr }; var obj2 = {}; var bool = moveProperty( obj1, 'a', obj2 ); console.log( obj2.a === arr ); // => true
-
The property is deleted from the source
object
. -
The property's descriptor is preserved during transfer.
-
If a source property is not
configurable
, the function throws anError
, as the property cannot be deleted from the sourceobject
.
Examples
var moveProperty = require( '@stdlib/utils-move-property' );
var obj1 = {
'beep': 'boop'
};
var obj2 = {
'foo': 'bar'
};
var bool = moveProperty( obj1, 'beep', obj2 );
if ( bool === false ) {
console.log( 'failed to move property' );
}
console.dir( obj1 );
/* =>
{}
*/
console.dir( obj2 );
/* =>
{
'foo': 'bar',
'beep': 'boop'
}
*/
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.