Skip to content

Commit

Permalink
doc: use consistent Default: in events
Browse files Browse the repository at this point in the history
The API docs have been migrating to **Default:** when providing
default values. This commit updates the events documentation page
for consistency.

PR-URL: #33678
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Juan José Arboleda <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
  • Loading branch information
cjihrig committed Jun 2, 2020
1 parent d534052 commit 16eaacf
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions doc/api/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ It supports the following option:

* `captureRejections` {boolean} It enables
[automatic capturing of promise rejection][capturerejections].
Default: `false`.
**Default:** `false`.

### Event: `'newListener'`
<!-- YAML
Expand Down Expand Up @@ -1218,11 +1218,12 @@ added: REPLACEME
* `listener` {Function|EventListener}
* `options` {Object}
* `once` {boolean} When `true`, the listener will be automatically removed
when it is first invoked. *Default*: `false`
when it is first invoked. **Default:** `false`.
* `passive` {boolean} When `true`, serves as a hint that the listener will
not call the `Event` object's `preventDefault()` method. *Default*: `false`
not call the `Event` object's `preventDefault()` method.
**Default:** `false`.
* `capture` {boolean} Not directly used by Node.js. Added for API
completeness. *Default*: `false`
completeness. **Default:** `false`.

Adds a new handler for the `type` event. Any given `listener` will be added
only once per `type` and per `capture` option value.
Expand Down

0 comments on commit 16eaacf

Please sign in to comment.