Skip to content

Commit

Permalink
doc: revise AbortSignal text and example using events.once()
Browse files Browse the repository at this point in the history
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 committed Sep 3, 2020
1 parent 69b8a39 commit f9c362f
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/api/events.md
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

0 comments on commit f9c362f

Please sign in to comment.