1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: revise example of assert.CallTracker

Browse Source 
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 <luigipinca@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
This commit is contained in:
Deokjin Kim 2023-03-30 03:17:18 +09:00 committed by GitHub
parent 143deae6d8
commit 2adb8b1054
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/api/assert.md
View File

@ -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()`