Skip to content

Commit 4dd4f6c

Browse files
aduh95targos
authored andcommitted
doc: document signal option for EventTarget#addEventListener
Refs: #36258 PR-URL: #43170 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Masashi Hirano <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent b6f9fa7 commit 4dd4f6c

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

doc/api/events.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1578,6 +1578,10 @@ changes:
15781578

15791579
<!-- YAML
15801580
added: v14.5.0
1581+
changes:
1582+
- version: v15.4.0
1583+
pr-url: https://github.com/nodejs/node/pull/36258
1584+
description: add support for `signal` option.
15811585
-->
15821586

15831587
* `type` {string}
@@ -1590,6 +1594,8 @@ added: v14.5.0
15901594
**Default:** `false`.
15911595
* `capture` {boolean} Not directly used by Node.js. Added for API
15921596
completeness. **Default:** `false`.
1597+
* `signal` {AbortSignal} The listener will be removed when the given
1598+
AbortSignal object's `abort()` method is called.
15931599

15941600
Adds a new handler for the `type` event. Any given `listener` is added
15951601
only once per `type` and per `capture` option value.

0 commit comments

Comments
 (0)