Skip to content

doc: make Extends usage consistent #33777

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
merged 3 commits into from
Jun 9, 2020
Merged

doc: make Extends usage consistent #33777

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2e49010
doc: make events Extends usage consistent
cjihrig Jun 6, 2020
85dbd17
doc: make perf_hooks Extends usage consistent
cjihrig Jun 6, 2020
862d005
doc: make globals Extends usage consistent
cjihrig Jun 6, 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
4 changes: 3 additions & 1 deletion doc/api/events.md
View file
Open in desktop
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`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The addition of the * Extends: line below is good, but to be honest I'd much prefer if we started adding the extends ... in the header line also as a best practice to make the extension more visible.

<!-- 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
4 changes: 3 additions & 1 deletion doc/api/globals.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,13 @@ added: REPLACEME

* Type: {AbortSignal}

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

* Extends: {EventTarget}

The `AbortSignal` is used to notify observers when the
`abortController.abort()` method is called.

Expand Down
4 changes: 3 additions & 1 deletion doc/api/perf_hooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,11 +255,13 @@ The value may be one of:
* `perf_hooks.constants.NODE_PERFORMANCE_GC_FLAGS_ALL_EXTERNAL_MEMORY`
* `perf_hooks.constants.NODE_PERFORMANCE_GC_FLAGS_SCHEDULE_IDLE`

## Class: `PerformanceNodeTiming extends PerformanceEntry`
## Class: `PerformanceNodeTiming`
<!-- YAML
added: v8.5.0
-->

* Extends: {PerformanceEntry}

_This property is an extension by Node.js. It is not available in Web browsers._

Provides timing details for Node.js itself. The constructor of this class
Expand Down
7 changes: 3 additions & 4 deletions tools/doc/type-parser.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,7 @@ const customTypesMap = {
'this': `${jsDocPrefix}Reference/Operators/this`,

'AbortController': 'globals.html#globals_class_abortcontroller',
'AbortSignal':
'globals.html#globals_class_abortsignal_extends_eventtarget',
'AbortSignal': 'globals.html#globals_class_abortsignal',

'ArrayBufferView':
'https://developer.mozilla.org/en-US/docs/Web/API/ArrayBufferView',
Expand Down Expand Up @@ -127,14 +126,14 @@ 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',

'Histogram': 'perf_hooks.html#perf_hooks_class_histogram',
'PerformanceEntry': 'perf_hooks.html#perf_hooks_class_performanceentry',
'PerformanceNodeTiming':
'perf_hooks.html#perf_hooks_class_performancenodetiming_extends_performanceentry', // eslint-disable-line max-len
'perf_hooks.html#perf_hooks_class_performancenodetiming',
'PerformanceObserver':
'perf_hooks.html#perf_hooks_class_perf_hooks_performanceobserver',
'PerformanceObserverEntryList':
Expand Down