Skip to content

Commit cc754f2

Browse files
committed
doc: make AbortSignal text consistent in events.md
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>
1 parent f9c362f commit cc754f2

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

doc/api/events.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1010,8 +1010,7 @@ added:
10101010
* `emitter` {EventEmitter}
10111011
* `eventName` {string|symbol} The name of the event being listened for
10121012
* `options` {Object}
1013-
* `signal` {AbortSignal} An {AbortSignal} that can be used to cancel awaiting
1014-
events.
1013+
* `signal` {AbortSignal} Can be used to cancel awaiting events.
10151014
* Returns: {AsyncIterator} that iterates `eventName` events emitted by the `emitter`
10161015

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

1044-
An {AbortSignal} may be used to cancel waiting on events:
1043+
An {AbortSignal} can be used to cancel waiting on events:
10451044

10461045
```js
10471046
const { on, EventEmitter } = require('events');

0 commit comments

Comments
 (0)