From e29a1462c7dd203c86a2400e2e6cd86757e49a4a Mon Sep 17 00:00:00 2001 From: Deokjin Kim Date: Thu, 30 Mar 2023 03:17:18 +0900 Subject: [PATCH] doc: revise example of assert.CallTracker In example of tracker.getCalls(), actual and expected are mismatched. So update expected value. In example of tracker.report(), user can check report easily through console.log(). In example of tracker.reset(), defining of tracker is missed in CJS. Plus, use assert.strictEqual() to check result. PR-URL: https://github.com/nodejs/node/pull/47252 Reviewed-By: Luigi Pinca Reviewed-By: Antoine du Hamel --- doc/api/assert.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/doc/api/assert.md b/doc/api/assert.md index d40300cc3fdb1b..1467d633c25ffd 100644 --- a/doc/api/assert.md +++ b/doc/api/assert.md @@ -348,7 +348,7 @@ const callsfunc = tracker.calls(func); callsfunc(1, 2, 3); assert.deepStrictEqual(tracker.getCalls(callsfunc), - [{ thisArg: this, arguments: [1, 2, 3 ] }]); + [{ thisArg: undefined, arguments: [1, 2, 3] }]); ``` ```cjs @@ -362,7 +362,7 @@ const callsfunc = tracker.calls(func); callsfunc(1, 2, 3); assert.deepStrictEqual(tracker.getCalls(callsfunc), - [{ thisArg: this, arguments: [1, 2, 3 ] }]); + [{ thisArg: undefined, arguments: [1, 2, 3] }]); ``` ### `tracker.report()` @@ -399,7 +399,7 @@ function func() {} const callsfunc = tracker.calls(func, 2); // Returns an array containing information on callsfunc() -tracker.report(); +console.log(tracker.report()); // [ // { // message: 'Expected the func function to be executed 2 time(s) but was @@ -425,7 +425,7 @@ function func() {} const callsfunc = tracker.calls(func, 2); // Returns an array containing information on callsfunc() -tracker.report(); +console.log(tracker.report()); // [ // { // message: 'Expected the func function to be executed 2 time(s) but was @@ -462,24 +462,26 @@ const callsfunc = tracker.calls(func); callsfunc(); // Tracker was called once -tracker.getCalls(callsfunc).length === 1; +assert.strictEqual(tracker.getCalls(callsfunc).length, 1); tracker.reset(callsfunc); -tracker.getCalls(callsfunc).length === 0; +assert.strictEqual(tracker.getCalls(callsfunc).length, 0); ``` ```cjs const assert = require('node:assert'); +const tracker = new assert.CallTracker(); + function func() {} const callsfunc = tracker.calls(func); callsfunc(); // Tracker was called once -tracker.getCalls(callsfunc).length === 1; +assert.strictEqual(tracker.getCalls(callsfunc).length, 1); tracker.reset(callsfunc); -tracker.getCalls(callsfunc).length === 0; +assert.strictEqual(tracker.getCalls(callsfunc).length, 0); ``` ### `tracker.verify()`