@stdlib/utils-move-property
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.7 • Public • Published

    Move Property

    NPM version Build Status Coverage Status dependencies

    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 an Error, as the property cannot be deleted from the source object.

    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

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2021. The Stdlib Authors.

    Install

    npm i @stdlib/utils-move-property

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    2

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    37.4 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser