Skip to content

Commit

Permalink
doc: make events Extends usage consistent
Browse files Browse the repository at this point in the history
The docs use `* Extends: {type}` to define inheritance. This
commit updates the events documentation to be consistent.

PR-URL: #33777
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
  • Loading branch information
cjihrig committed Jun 9, 2020
1 parent 4ba9080 commit 2e49010
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
4 changes: 3 additions & 1 deletion doc/api/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -1277,11 +1277,13 @@ added: REPLACEME

Removes the `listener` from the list of handlers for event `type`.

### Class: `NodeEventTarget extends EventTarget`
### Class: `NodeEventTarget`
<!-- YAML
added: REPLACEME
-->

* Extends: {EventTarget}

The `NodeEventTarget` is a Node.js-specific extension to `EventTarget`
that emulates a subset of the `EventEmitter` API.

Expand Down
2 changes: 1 addition & 1 deletion tools/doc/type-parser.js
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ const customTypesMap = {
'net.Socket': 'net.html#net_class_net_socket',

'NodeEventTarget':
'events.html#events_class_nodeeventtarget_extends_eventtarget',
'events.html#events_class_nodeeventtarget',

'os.constants.dlopen': 'os.html#os_dlopen_constants',

Expand Down

0 comments on commit 2e49010

Please sign in to comment.