Neural Processing Mechanisms

    @fav/prop.assign-deep

    1.0.2 • Public • Published

    @fav/prop.assign-deep NPM MIT License Build Status Build Status Coverage status

    Copys enumerable own properties of child and descendants of source objects to destination object.

    "fav" is an abbreviation of "favorite" and also the acronym of "for all versions". This package is intended to support all Node.js versions and many browsers as possible. At least, this package supports Node.js >= v0.10 and major Web browsers: Chrome, Firefox, IE11, Edge, Vivaldi and Safari.

    Install

    To install from npm:

    $ npm install --save @fav/prop.assign-deep

    NOTE: npm < 2.7.0 does not support scoped package, but old version Node.js supports it. So when you use such older npm, you should download this package from github.com, and move it in node_modules/@fav/prop.assign-deep/ directory manually.

    Usage

    For Node.js:

    var assignDeep = require('@fav/prop.assign-deep');
    assignDeep({ a: 1, b: { c: 1, d: 1 } }, { b: { c: 2, e: 2 }, f: 2 });
    // => { a: 1, b: { c: 2, d: 1, e: 2 }, f: 2 }

    For Web browsers:

    <script src="fav.prop.assign.min.js"></script>
    <script>
    var assignDeep = fav.prop.assignDeep;
    assignDeep({ a: 1, b: { c: 1, d: 1 } }, { b: { c: 2, e: 2 }, f: 2 });
    // => { a: 1, b: { c: 2, d: 1, e: 2 }, f: 2 }
    </script>

    API

    assignDeep(dest, [, ...srcs]) : object

    Copys all enumerable own properties deeply from one or more source objects to a destination object and returns a destination object. This function copys not only child properties but also descendants properties of source objects.

    NOTE: This function copys enumerable own properties of srcs objects (top level objects) like Object.assign, but copys properties of child and descendant objects (lower level objects) like primitive properties when those properties are not plain objects. For example:

    var src = new function() {
      this.a = { b: 1 };
      this.c = new function() { this.d = 2 };
    };
    console.log(src); // => { a: { b: 1 }, c: { d: 2 } }
    
    var dest = assignDeep({}, src);
    console.log(dest); // => { a: { b: 1 }, c: { d: 2 } }
    
    dest === src // => false
    dest.a === src.a // => false
    dest.c === src.c // => true
    

    NOTE: If the first argument is nullish, this function replace it to an empty plain object. If properties of first argument object are read only, this function ignore them and doesn't throw Errors.

    Parameters:

    Parameter Type Description
    dest object The destination object.
    srcs object The source object(s).

    Returns:

    The destination object.

    Type: object

    Checked

    Node.js (4〜)

    Platform 4 5 6 7 8 9 10
    macOS
    Windows10
    Linux

    io.js (1〜3)

    Platform 1 2 3
    macOS
    Windows10
    Linux

    Node.js (〜0.12)

    Platform 0.8 0.9 0.10 0.11 0.12
    macOS
    Windows10
    Linux

    Web browsers

    Platform Chrome Firefox Vivaldi Safari Edge IE11
    macOS -- --
    Windows10 --
    Linux -- -- --

    License

    Copyright (C) 2017-2018 Takayuki Sato

    This program is free software under MIT License. See the file LICENSE in this distribution for more details.

    Install

    npm i @fav/prop.assign-deep

    DownloadsWeekly Downloads

    3

    Version

    1.0.2

    License

    MIT

    Unpacked Size

    19 kB

    Total Files

    7

    Last publish

    Collaborators

    • sttk