diff options
author | cjihrig <cjihrig@gmail.com> | 2020-05-31 23:30:41 +0300 |
---|---|---|
committer | cjihrig <cjihrig@gmail.com> | 2020-06-03 00:16:52 +0300 |
commit | 16eaacfd2bad09a9bdada1908ea58657cce12ead (patch) | |
tree | 05392c6f4912ec14f1c79364de50faf89b98870c | |
parent | d5340526fdde06653330a63b73791d81d2585636 (diff) |
doc: use consistent Default: in events
The API docs have been migrating to **Default:** when providing
default values. This commit updates the events documentation page
for consistency.
PR-URL: https://github.com/nodejs/node/pull/33678
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
-rw-r--r-- | doc/api/events.md | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/api/events.md b/doc/api/events.md index 7423ae7adb1..6929e8fa9cf 100644 --- a/doc/api/events.md +++ b/doc/api/events.md @@ -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 @@ -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. |