Skip to content

doc: update events docs for consistency #33678

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cjihrig merged 2 commits into from
Jun 2, 2020
Merged

doc: update events docs for consistency #33678

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d534052
doc: remove "it is important"
cjihrig May 31, 2020
16eaacf
doc: use consistent Default: in events
cjihrig May 31, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
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: #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>
  • Loading branch information
@cjihrig
cjihrig committed Jun 2, 2020
commit 16eaacfd2bad09a9bdada1908ea58657cce12ead
9 changes: 5 additions & 4 deletions doc/api/events.md
View file
Open in desktop
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