Skip to content

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

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
Trott merged 2 commits into from
Sep 3, 2020
Merged

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

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f9c362f
doc: revise AbortSignal text and example using events.once()
Trott Sep 1, 2020
cc754f2
doc: make AbortSignal text consistent in events.md
Trott Sep 3, 2020
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
Next Next commit
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
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
  • Loading branch information
@Trott
Trott committed Sep 3, 2020
commit f9c362ff6c4fad4cf67df5a94ba5fdb9321a3d2b
6 changes: 3 additions & 3 deletions doc/api/events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -835,8 +835,7 @@ added:
* `emitter` {EventEmitter}
* `name` {string}
* `options` {Object}
* `signal` {AbortSignal} An {AbortSignal} that may be used to cancel waiting
for the event.
* `signal` {AbortSignal} Can be used to cancel waiting for the event.
* Returns: {Promise}

Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given
Expand Down Expand Up @@ -895,7 +894,7 @@ ee.emit('error', new Error('boom'));
// Prints: ok boom
```

An {AbortSignal} may be used to cancel waiting for the event early:
An {AbortSignal} can be used to cancel waiting for the event:

```js
const { EventEmitter, once } = require('events');
Expand All @@ -918,6 +917,7 @@ async function foo(emitter, event, signal) {

foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!
```

### Awaiting multiple events emitted on `process.nextTick()`
Expand Down