Skip to content

doc: clarify after and afterEach hooks execution #51523

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

Merged
merged 5 commits into from
Feb 3, 2024
Merged

doc: clarify after and afterEach hooks execution #51523

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1a23c68
doc: clarify execution of `after` hook on test suite completion
ognjenjevremovic Jan 19, 2024
19da229
doc: clarify execution of `afterEach` hook after each test
ognjenjevremovic Jan 19, 2024
669ccaa
doc: improve clarity in after and afterEach hook documentation
ognjenjevremovic Jan 19, 2024
8a1bedd
doc: improve clarity in after and afterEach hook documentation
ognjenjevremovic Jan 20, 2024
4311384
doc: address line length linting error in documentation
ognjenjevremovic Jan 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions doc/api/test.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1420,6 +1420,8 @@ describe('tests', async () => {
});
```

**Note:** The `after` hook is guaranteed to run, even if tests within the suite fail.

## `beforeEach([fn][, options])`

<!-- YAML
Expand Down Expand Up @@ -1473,6 +1475,9 @@ added:
This function is used to create a hook running
after each subtest of the current test.

**Note:** The `afterEach` hook is guaranteed to run after every test,
even if any of the tests fail.

```js
describe('tests', async () => {
afterEach(() => console.log('finished running a test'));
Expand Down