[chai] added missing notIncludeDeepMembers assertion

DefinitelyTyped · Apr 2, 2024 · 9364edf · 9364edf
1 parent e5d07ac
commit 9364edf
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/types/chai/chai-tests.ts b/types/chai/chai-tests.ts
@@ -2489,4 +2489,8 @@ suite("assert", () => {
             "Should have correct value of the property",
         );
     });
+
+    test("notIncludeDeepMembers", () => {
+        assert.notIncludeDeepMembers([{ a: 1 }, { b: 2 }, { c: 3 }], [{ b: 2 }], "not include deep members");
+    });
 });
diff --git a/types/chai/index.d.ts b/types/chai/index.d.ts
@@ -1483,6 +1483,19 @@ declare namespace Chai {
          */
         includeDeepMembers<T>(superset: T[], subset: T[], message?: string): void;
 
+        /**
+         * Asserts that `subset` isn't included in `superset` in any order. Uses a
+         * deep equality check. Duplicates are ignored.
+         *
+         * assert.notIncludeDeepMembers([ { a: 1 }, { b: 2 }, { c: 3 } ], [ { b: 2 }, { f: 5 } ], 'not include deep members');
+         *
+         * T   Type of set values.
+         * @param superset   Actual set of values.
+         * @param subset   Potential contained set of values.
+         * @param message   Message to display on error.
+         */
+        notIncludeDeepMembers<T>(superset: T[], subset: T[], message?: string): void;
+
         /**
          * Asserts that non-object, non-array value inList appears in the flat array list.
          *