Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: revise example of assert.CallTracker #47252

Merged
merged 3 commits into from Mar 29, 2023
Merged

doc: revise example of assert.CallTracker #47252

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7c04863
doc: revise example of assert.CallTracker
deokjinkim Mar 25, 2023
486d2e7
fix odd spacing in `arguments`
deokjinkim Mar 27, 2023
a674cb4
use `undefined` instead of `this` for ESM
deokjinkim Mar 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 10 additions & 8 deletions doc/api/assert.md
View file
Open in desktop
Expand Up @@ -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
Expand All @@ -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()`
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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()`
Expand Down