Next Perpendicular Moonlanding

    return-deep-diff

    0.4.0 • Public • Published

    Deep Diff

    Build Status npm Coverage Status

    Function returning an object representing the difference between two objects. The function is immutable-compliant as it does not affect the arguments.

    Installation

    npm install -S return-deep-diff
    

    Usage

    import deepDiff from 'return-deep-diff'
     
    const objOne = {
      a: 1,
      b: {
        c: 2,
        d: 3
      },
      e: 4
    }
     
    const objTwo = {
      a: 1,
      b: {
        c: 2,
        d: 30,
        f: 50
      },
      e: 40
    }
     
    console.log(deepDiff(objOne, objTwo))
    /*
    returns:
      {
        b: {
          d: 30
        },
        e: 40
      }
    */
     
    console.log(deepDiff(objOne, objTwo, true))
    /*
    returns:
      {
        b: {
          d: 30
          f: 50
        },
        e: 40
      }
    */

    The two objects must share the exact same structure, which is defined by the first object. If a key is present in the second but not the first object, it will not be present in the diff object unless keepNewKeys equals true. The function does not mutate neither the first nor the second object.

    Install

    npm i return-deep-diff

    DownloadsWeekly Downloads

    2,375

    Version

    0.4.0

    License

    ISC

    Unpacked Size

    12.7 kB

    Total Files

    10

    Last publish

    Collaborators

    • dispix