Nanobot: Polygonal Mascot

    @stdlib/assert-deep-equal
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.7 • Public • Published

    deepEqual

    NPM version Build Status Coverage Status

    Test for deep equality between two values.

    Installation

    npm install @stdlib/assert-deep-equal

    Usage

    var deepEqual = require( '@stdlib/assert-deep-equal' );

    deepEqual( a, b )

    Returns a boolean indicating if a is deep equal to b.

    var bool = deepEqual( [ 1, 2, 3 ], [ 1, 2, 3 ] );
    // returns true
    
    bool = deepEqual( [ 1, 2, 3 ], [ 1, 2, '3' ] );
    // returns false
    
    bool = deepEqual( { 'a': 2 }, { 'a': [ 2 ] } );
    // returns false

    Notes

    • The function uses strict equality checks (===) and does not perform any type coercion.
    • When given two objects, only enumerable own properties are recursively compared.

    Examples

    var deepEqual = require( '@stdlib/assert-deep-equal' );
    var bool;
    var a;
    var b;
    
    a = [ true, false, true ];
    b = [ true, false, true ];
    bool = deepEqual( a, b );
    // returns true
    
    b.pop();
    bool = deepEqual( a, b );
    // returns false
    
    a = { 'a': { 'b': { 'c': 'd' } } };
    b = { 'a': { 'b': { 'c': 'd' } } };
    bool = deepEqual( a, b );
    // returns true
    
    b.a.b.c = null;
    bool = deepEqual( a, b );
    // returns false
    
    a = { 'a': [ { 'b': 0 }, { 'c': 1 } ] };
    b = { 'a': [ { 'b': 0 }, { 'c': 1 } ] };
    bool = deepEqual( a, b );
    // returns true
    
    b = { 'a': [ { 'b': [ 0 ] }, { 'c': '1' } ] };
    bool = deepEqual( a, b );
    // returns false

    See Also


    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-2022. The Stdlib Authors.

    Install

    npm i @stdlib/assert-deep-equal

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    31

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    39 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser