From 5d521eb701200137234daa52dea5c731bfc8afa9 Mon Sep 17 00:00:00 2001
From: Eric Eastwood <contact@ericeastwood.com>
Date: Thu, 9 Jan 2020 01:14:44 -0600
Subject: [PATCH] doc: update assert.rejects() docs with a validation function
 example

Spawned from my own struggle to use in https://gitlab.com/gitlab-org/gitter/webapp/merge_requests/1702#note_268452483
---
 doc/api/assert.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/doc/api/assert.md b/doc/api/assert.md
index b3e3a0ed3238ba..456d0a61aecc43 100644
--- a/doc/api/assert.md
+++ b/doc/api/assert.md
@@ -1133,6 +1133,21 @@ if the `asyncFn` fails to reject.
 })();
 ```
 
+```js
+(async () => {
+  await assert.rejects(
+    async () => {
+      throw new TypeError('Wrong value');
+    },
+    (err) => {
+      assert.strictEqual(err.name, 'TypeError');
+      assert.strictEqual(err.message, 'Wrong value');
+      return true;
+    }
+  );
+})();
+```
+
 ```js
 assert.rejects(
   Promise.reject(new Error('Wrong value')),