Skip to content
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.

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

[v6.x backport] doc: linkify missing types #19500

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion doc/api/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ It is not emitted in the worker.
added: v0.7.7
-->

* Returns: {Worker} A reference to `worker`.
* Returns: {cluster.Worker} A reference to `worker`.

In a worker, this function will close all servers, wait for the `'close'` event on
those servers, and then disconnect the IPC channel.
Expand Down
14 changes: 7 additions & 7 deletions doc/api/readline.md
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,7 @@ Interface's `input` *as if it were provided by the user*.
added: v0.7.7
-->

* `stream` {Writable}
* `stream` {stream.Writable}
* `dir` {number}
* `-1` - to the left from cursor
* `1` - to the right from cursor
Expand All @@ -338,7 +338,7 @@ in a specified direction identified by `dir`.
added: v0.7.7
-->

* `stream` {Writable}
* `stream` {stream.Writable}

The `readline.clearScreenDown()` method clears the given [TTY][] stream from
the current position of the cursor down.
Expand All @@ -349,9 +349,9 @@ added: v0.1.98
-->

* `options` {Object}
* `input` {Readable} The [Readable][] stream to listen to. This option is
* `input` {stream.Readable} The [Readable][] stream to listen to. This option is
*required*.
* `output` {Writable} The [Writable][] stream to write readline data to.
* `output` {stream.Writable} The [Writable][] stream to write readline data to.
* `completer` {Function} An optional function used for Tab autocompletion.
* `terminal` {boolean} `true` if the `input` and `output` streams should be
treated like a TTY, and have ANSI/VT100 escape codes written to it.
Expand Down Expand Up @@ -431,7 +431,7 @@ function completer(linePartial, callback) {
added: v0.7.7
-->

* `stream` {Writable}
* `stream` {stream.Writable}
* `x` {number}
* `y` {number}

Expand All @@ -443,7 +443,7 @@ given [TTY][] `stream`.
added: v0.7.7
-->

* `stream` {Readable}
* `stream` {stream.Readable}
* `interface` {readline.Interface}

The `readline.emitKeypressEvents()` method causes the given [Readable][]
Expand All @@ -469,7 +469,7 @@ if (process.stdin.isTTY)
added: v0.7.7
-->

* `stream` {Writable}
* `stream` {stream.Writable}
* `dx` {number}
* `dy` {number}

Expand Down
4 changes: 2 additions & 2 deletions doc/api/repl.md
Original file line number Diff line number Diff line change
Expand Up @@ -381,9 +381,9 @@ added: v0.1.91

* `options` {Object | string}
* `prompt` {string} The input prompt to display. Defaults to `> `.
* `input` {Readable} The Readable stream from which REPL input will be read.
* `input` {stream.Readable} The Readable stream from which REPL input will be read.
Defaults to `process.stdin`.
* `output` {Writable} The Writable stream to which REPL output will be
* `output` {stream.Writable} The Writable stream to which REPL output will be
written. Defaults to `process.stdout`.
* `terminal` {boolean} If `true`, specifies that the `output` should be
treated as a TTY terminal, and have ANSI/VT100 escape codes written to it.
Expand Down
8 changes: 4 additions & 4 deletions doc/api/stream.md
Original file line number Diff line number Diff line change
Expand Up @@ -385,7 +385,7 @@ added: v0.11.15
-->

* `encoding` {string} The new default encoding
* Returns: `this`
* Returns: {this}

The `writable.setDefaultEncoding()` method sets the default `encoding` for a
[Writable][] stream.
Expand Down Expand Up @@ -771,7 +771,7 @@ readable.isPaused(); // === false
added: v0.9.4
-->

* Returns: `this`
* Returns: {this}

The `readable.pause()` method will cause a stream in flowing mode to stop
emitting [`'data'`][] events, switching out of flowing mode. Any data that
Expand Down Expand Up @@ -903,7 +903,7 @@ event has been emitted will return `null`. No runtime error will be raised.
added: v0.9.4
-->

* Returns: `this`
* Returns: {this}

The `readable.resume()` method causes an explicitly paused Readable stream to
resume emitting [`'data'`][] events, switching the stream into flowing mode.
Expand All @@ -926,7 +926,7 @@ added: v0.9.4
-->

* `encoding` {string} The encoding to use.
* Returns: `this`
* Returns: {this}

The `readable.setEncoding()` method sets the character encoding for
data read from the Readable stream.
Expand Down
53 changes: 40 additions & 13 deletions tools/doc/type-parser.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,31 +14,58 @@ const jsPrimitives = {
'undefined': 'Undefined'
};
const jsGlobalTypes = [
'Error', 'Object', 'Function', 'Array', 'TypedArray', 'Uint8Array',
'Uint16Array', 'Uint32Array', 'Int8Array', 'Int16Array', 'Int32Array',
'Uint8ClampedArray', 'Float32Array', 'Float64Array', 'Date', 'RegExp',
'ArrayBuffer', 'DataView', 'Promise', 'EvalError', 'RangeError',
'ReferenceError', 'SyntaxError', 'TypeError', 'URIError'
'Array', 'ArrayBuffer', 'DataView', 'Date', 'Error', 'EvalError',
'Float32Array', 'Float64Array', 'Function', 'Int16Array', 'Int32Array',
'Int8Array', 'Object', 'Promise', 'RangeError', 'ReferenceError', 'RegExp',
'SharedArrayBuffer', 'SyntaxError', 'TypeError', 'TypedArray', 'URIError',
'Uint16Array', 'Uint32Array', 'Uint8Array', 'Uint8ClampedArray'
];
const typeMap = {
'Iterable':
'https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterable_protocol',
'Iterator':
'https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol',

'this':
'https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/this',

'Buffer': 'buffer.html#buffer_class_buffer',
'Handle': 'net.html#net_server_listen_handle_backlog_callback',
'Stream': 'stream.html#stream_stream',
'stream.Writable': 'stream.html#stream_class_stream_writable',
'stream.Readable': 'stream.html#stream_class_stream_readable',
'stream.Duplex': 'stream.html#stream_class_stream_duplex',

'ChildProcess': 'child_process.html#child_process_class_childprocess',

'cluster.Worker': 'cluster.html#cluster_class_worker',

'dgram.Socket': 'dgram.html#dgram_class_dgram_socket',
'net.Socket': 'net.html#net_class_net_socket',
'tls.TLSSocket': 'tls.html#tls_class_tls_tlssocket',

'Domain': 'domain.html#domain_class_domain',

'EventEmitter': 'events.html#events_class_eventemitter',
'Timer': 'timers.html#timers_timers',

'fs.Stats': 'fs.html#fs_class_fs_stats',

'http.Agent': 'http.html#http_class_http_agent',
'http.ClientRequest': 'http.html#http_class_http_clientrequest',
'http.IncomingMessage': 'http.html#http_class_http_incomingmessage',
'http.Server': 'http.html#http_class_http_server',
'http.ServerResponse': 'http.html#http_class_http_serverresponse',

'Handle': 'net.html#net_server_listen_handle_backlog_callback',
'net.Server': 'net.html#net_class_net_server',
'net.Socket': 'net.html#net_class_net_socket',

'readline.Interface': 'readline.html#readline_class_interface',

'Stream': 'stream.html#stream_stream',
'stream.Duplex': 'stream.html#stream_class_stream_duplex',
'stream.Readable': 'stream.html#stream_class_stream_readable',
'stream.Writable': 'stream.html#stream_class_stream_writable',

'Immediate': 'timers.html#timers_class_immediate',
'Timeout': 'timers.html#timers_class_timeout',
'Timer': 'timers.html#timers_timers',

'tls.TLSSocket': 'tls.html#tls_class_tls_tlssocket',

'URL': 'url.html#url_the_whatwg_url_api',
'URLSearchParams': 'url.html#url_class_urlsearchparams'
};
Expand Down