Skip to content

Commit

Permalink
doc: make AbortSignal text consistent in events.md
Browse files Browse the repository at this point in the history
Further minor modifications to AbortSignal text in events.md for
consistency.

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 f9c362f commit cc754f2
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions doc/api/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -1010,8 +1010,7 @@ added:
* `emitter` {EventEmitter}
* `eventName` {string|symbol} The name of the event being listened for
* `options` {Object}
* `signal` {AbortSignal} An {AbortSignal} that can be used to cancel awaiting
events.
* `signal` {AbortSignal} Can be used to cancel awaiting events.
* Returns: {AsyncIterator} that iterates `eventName` events emitted by the `emitter`

```js
Expand Down Expand Up @@ -1041,7 +1040,7 @@ if the `EventEmitter` emits `'error'`. It removes all listeners when
exiting the loop. The `value` returned by each iteration is an array
composed of the emitted event arguments.

An {AbortSignal} may be used to cancel waiting on events:
An {AbortSignal} can be used to cancel waiting on events:

```js
const { on, EventEmitter } = require('events');
Expand Down

0 comments on commit cc754f2

Please sign in to comment.