@types/deep-equal-in-any-order

Installation

npm install --save @types/deep-equal-in-any-order

Summary

This package contains type definitions for deep-equal-in-any-order (https://github.com/oprogramador/deep-equal-in-any-order#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/deep-equal-in-any-order.

index.d.ts

declare global {
    namespace Chai {
        interface Deep {
            equalInAnyOrder: Equal;
        }
    }
}

declare global {
    namespace Chai {
        interface Assert {
            /**
             * It works in similar way as deepEqual but it doesn’t checks the arrays order (at any level of nested objects and arrays).
             * The array elements can be any JS entity (boolean, null, number, string, object, array…).
             *
             * T   Type of the objects.
             * @param actual   Actual value.
             * @param expected   Potential expected value.
             * @param message   Message to display on error.
             */
            deepEqualInAnyOrder: <T>(actual: T, expected: T, message?: string) => void;

            /**
             * It works in similar way as notDeepEqual but it doesn’t checks the arrays order (at any level of nested objects and arrays).
             * The array elements can be any JS entity (boolean, null, number, string, object, array…).
             *
             * T   Type of the objects.
             * @param actual   Actual value.
             * @param expected   Potential expected value.
             * @param message   Message to display on error.
             */
            notDeepEqualInAnyOrder: <T>(actual: T, expected: T, message?: string) => void;
        }
    }
}

declare const deepEqualInAnyOrder: Chai.ChaiPlugin;
export = deepEqualInAnyOrder;

Additional Details

• Last updated: Fri, 13 Dec 2024 13:09:04 GMT
• Dependencies: none

Credits

These definitions were written by Bastien Caudan.