Sitelet https://web.archive.org/web/20220419175512/https://github.com/nodejs/node/commit/862d005e60
Skip to content
Permalink
Browse files
doc: make globals Extends usage consistent
The docs use `* Extends: {type}` to define inheritance. This
commit updates the globals 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 85dbd17 commit 862d005e603e8897336ee021094106c402603c2d
Showing with 4 additions and 3 deletions.
  1. +3 −1 doc/api/globals.md
  2. +1 −2 tools/doc/type-parser.js
@@ -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.

@@ -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',

0 comments on commit 862d005

Please sign in to comment.