Commit e93615c
doc: make AbortSignal text consistent in events.md
Further minor modifications to AbortSignal text in events.md for
consistency.
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 1a362d8 commit e93615c
1 file changed
Lines changed: 2 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1014,8 +1014,7 @@ added: | |||
| 1014 | 1014 | * `emitter` {EventEmitter} | |
| 1015 | 1015 | * `eventName` {string|symbol} The name of the event being listened for | |
| 1016 | 1016 | * `options` {Object} | |
| 1017 | - * `signal` {AbortSignal} An {AbortSignal} that can be used to cancel awaiting | ||
| 1018 | - events. | ||
| 1017 | + * `signal` {AbortSignal} Can be used to cancel awaiting events. | ||
| 1019 | 1018 | * Returns: {AsyncIterator} that iterates `eventName` events emitted by the `emitter` | |
| 1020 | 1019 | ||
| 1021 | 1020 | ```js | |
@@ -1045,7 +1044,7 @@ if the `EventEmitter` emits `'error'`. It removes all listeners when | |||
| 1045 | 1044 | exiting the loop. The `value` returned by each iteration is an array | |
| 1046 | 1045 | composed of the emitted event arguments. | |
| 1047 | 1046 | ||
| 1048 | - An {AbortSignal} may be used to cancel waiting on events: | ||
| 1047 | + An {AbortSignal} can be used to cancel waiting on events: | ||
| 1049 | 1048 | ||
| 1050 | 1049 | ```js | |
| 1051 | 1050 | const { on, EventEmitter } = require('events'); | |
0 commit comments