From 07626645e784ebc7f7335e40c439a39f9ae13864 Mon Sep 17 00:00:00 2001 From: "Yasser A.Idrissi" Date: Tue, 2 Mar 2021 15:05:38 +0100 Subject: [PATCH] docs(testing): add assertObjectMatch example (#9645) --- docs/testing/assertions.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/testing/assertions.md b/docs/testing/assertions.md index e80e760fe1..9de7d1f350 100644 --- 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, expected: Record): void` - `assertThrows(fn: () => void, ErrorClass?: Constructor, msgIncludes = "", msg?: string): Error` - `assertThrowsAsync(fn: () => Promise, ErrorClass?: Constructor, msgIncludes = "", msg?: string): Promise` @@ -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,