docs(testing): add assertObjectMatch example (denoland#9645)

eugenehp · Mar 2, 2021 · 0762664 · 0762664
1 parent faf2e80
commit 0762664
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/docs/testing/assertions.md b/docs/testing/assertions.md
@@ -22,6 +22,7 @@ The assertions module provides 10 assertions:
 - `assertArrayIncludes(actual: unknown[], expected: unknown[], msg?: string): void`
 - `assertMatch(actual: string, expected: RegExp, msg?: string): void`
 - `assertNotMatch(actual: string, expected: RegExp, msg?: string): void`
+- `assertObjectMatch( actual: Record<PropertyKey, unknown>, expected: Record<PropertyKey, unknown>): void`
 - `assertThrows(fn: () => void, ErrorClass?: Constructor, msgIncludes = "", msg?: string): Error`
 - `assertThrowsAsync(fn: () => Promise<void>, ErrorClass?: Constructor, msgIncludes = "", msg?: string): Promise<Error>`
 
@@ -136,6 +137,21 @@ Deno.test("Test Assert Not Match", () => {
 });
 ```
 
+### Object
+
+Use `assertObjectMatch` to check that a JavaScript object matches a subset of
+the properties of an object.
+
+```js
+// Simple subset
+assertObjectMatch(
+ { foo: true, bar: false },
+ {
+ foo: true,
+ },
+);
+```
+
 ### Throws
 
 There are two ways to assert whether something throws an error in Deno,