doc: clarify execution of `after` hook on test suite completion · nodejs/node@b3157a0 · GitHub

nodejs / node Public

• Notifications You must be signed in to change notification settings
• Fork 36.6k
• Star 120k

• Code
• Issues 635
• Pull requests 755
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit b3157a0

Browse filesBrowse the repository at this point in the historyBrowse files

ognjenjevremovic

authored and

richardlau

committed

doc: clarify execution of after hook on test suite completion

The `after` hook now explicitly mentions that it is executed once after all the tests in a test suite have completed, regardless of whether the tests passed or failed. This ensures that cleanup tasks or actions specified in the after hook are guaranteed to run. Refs: #50901 PR-URL: #51523 Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Moshe Atlow <moshe@atlow.co.il>

1 parent 8e84aad commit b3157a0
Copy full SHA for b3157a0

1 file changed

+6Lines changed: 6 additions & 0 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• doc/api
  • test.md

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎doc/api/test.md‎

Copy file name to clipboardExpand all lines: doc/api/test.md

+6Lines changed: 6 additions & 0 deletions

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -1435,6 +1435,9 @@ describe('tests', async () => {
1435	1435	});
1436	1436	```
1437	1437
	1438	+ **Note:** The `after` hook is guaranteed to run,
	1439	+ even if tests within the suite fail.
	1440	+
1438	1441	## `beforeEach([fn][, options])`
1439	1442
1440	1443	<!-- YAML
@@ -1488,6 +1491,9 @@ added:
1488	1491	This function is used to create a hook running
1489	1492	after each subtest of the current test.
1490	1493
	1494	+ **Note:** The `afterEach` hook is guaranteed to run after every test,
	1495	+ even if any of the tests fail.
	1496	+
1491	1497	```js
1492	1498	describe('tests', async () => {
1493	1499	afterEach(() => console.log('finished running a test'));

0 commit comments

Comments

0 (0)