doc: revise AbortSignal text and example using events.once() · nodejs/node@1a362d8 · GitHub

nodejs / node Public

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

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

Additional navigation options

Commit 1a362d8

Browse filesBrowse the repository at this point in the historyBrowse files

Trott

authored and

targos

committed

doc: revise AbortSignal text and example using events.once()

Add a line to the example code to clarify what happens if an event is emitted after listening is canceled. Make minor revisions to surrounding text. PR-URL: #35005 Backport-PR-URL: #38386 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>

1 parent 3f33b5a commit 1a362d8
Copy full SHA for 1a362d8

1 file changed

+3-3Lines changed: 3 additions & 3 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• doc/api
  • events.md

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎doc/api/events.md‎

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

+3-3Lines changed: 3 additions & 3 deletions

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -839,8 +839,7 @@ added:
839	839	* `emitter` {EventEmitter}
840	840	* `name` {string}
841	841	* `options` {Object}
842		- * `signal` {AbortSignal} An {AbortSignal} that may be used to cancel waiting
843		- for the event.
	842	+ * `signal` {AbortSignal} Can be used to cancel waiting for the event.
844	843	* Returns: {Promise}
845	844
846	845	Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given
@@ -899,7 +898,7 @@ ee.emit('error', new Error('boom'));
899	898	// Prints: ok boom
900	899	```
901	900
902		- An {AbortSignal} may be used to cancel waiting for the event early:
	901	+ An {AbortSignal} can be used to cancel waiting for the event:
903	902
904	903	```js
905	904	const { EventEmitter, once } = require('events');
@@ -922,6 +921,7 @@ async function foo(emitter, event, signal) {
922	921
923	922	foo(ee, 'foo', ac.signal);
924	923	ac.abort(); // Abort waiting for the event
	924	+ ee.emit('foo'); // Prints: Waiting for the event was canceled!
925	925	```
926	926
927	927	### Awaiting multiple events emitted on `process.nextTick()`

0 commit comments

Comments

0 (0)