@stdlib/assert/deep-equal/docs/repl.txt

Standard assertion utilities.

{{alias}}( a, b )
    Tests for deep equality between two values.

    Parameters
    ----------
    a: any
        First comparison value.

    b: any
        Second comparison value.

    Returns
    -------
    out: boolean
        Boolean indicating if `a` is deep equal to `b`.

    Examples
    --------
    > var bool = {{alias}}( [ 1, 2, 3 ], [ 1, 2, 3 ] )
    true

    > bool = {{alias}}( [ 1, 2, 3 ], [ 1, 2, '3' ] )
    false

    > bool = {{alias}}( { 'a': 2 }, { 'a': [ 2 ] } )
    false

    See Also
    --------