diff options
author | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2018-01-30 00:15:53 +0200 |
---|---|---|
committer | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2018-02-01 02:52:31 +0200 |
commit | fd3a0cfb7c467c8016ad739a473be864425e645d (patch) | |
tree | 568d5c3dc5b476e87b620251bf72601ff526b849 /doc | |
parent | 83d0f4c92b46fa0fbd13e9ebc7a473275da04e2e (diff) | |
download | android-node-v8-fd3a0cfb7c467c8016ad739a473be864425e645d.tar.gz android-node-v8-fd3a0cfb7c467c8016ad739a473be864425e645d.tar.bz2 android-node-v8-fd3a0cfb7c467c8016ad739a473be864425e645d.zip |
doc: linkify missing types
Also, alphabetize all types in type-parser.js
and fix some nits in type formats.
PR-URL: https://github.com/nodejs/node/pull/18444
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/async_hooks.md | 2 | ||||
-rw-r--r-- | doc/api/cluster.md | 2 | ||||
-rw-r--r-- | doc/api/console.md | 4 | ||||
-rw-r--r-- | doc/api/fs.md | 2 | ||||
-rw-r--r-- | doc/api/http2.md | 2 | ||||
-rw-r--r-- | doc/api/process.md | 2 | ||||
-rw-r--r-- | doc/api/readline.md | 14 | ||||
-rw-r--r-- | doc/api/repl.md | 4 | ||||
-rw-r--r-- | doc/api/stream.md | 10 | ||||
-rw-r--r-- | doc/api/tty.md | 2 |
10 files changed, 22 insertions, 22 deletions
diff --git a/doc/api/async_hooks.md b/doc/api/async_hooks.md index 4fa23f28d1..781509900c 100644 --- a/doc/api/async_hooks.md +++ b/doc/api/async_hooks.md @@ -86,7 +86,7 @@ added: v8.1.0 * `before` {Function} The [`before` callback][]. * `after` {Function} The [`after` callback][]. * `destroy` {Function} The [`destroy` callback][]. -* Returns: `{AsyncHook}` Instance used for disabling and enabling hooks +* Returns: {AsyncHook} Instance used for disabling and enabling hooks Registers functions to be called for different lifetime events of each async operation. diff --git a/doc/api/cluster.md b/doc/api/cluster.md index 1817ac8202..3063af83bd 100644 --- a/doc/api/cluster.md +++ b/doc/api/cluster.md @@ -267,7 +267,7 @@ changes: description: This method now returns a reference to `worker`. --> -* 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. diff --git a/doc/api/console.md b/doc/api/console.md index 76f6c6ac46..68cab5b68f 100644 --- a/doc/api/console.md +++ b/doc/api/console.md @@ -78,8 +78,8 @@ const { Console } = console; ``` ### new Console(stdout[, stderr]) -* `stdout` {Writable} -* `stderr` {Writable} +* `stdout` {stream.Writable} +* `stderr` {stream.Writable} Creates a new `Console` with one or two writable stream instances. `stdout` is a writable stream to print log or info output. `stderr` is used for warning or diff --git a/doc/api/fs.md b/doc/api/fs.md index 8e6ca9e7dd..d5e7f75ebe 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -798,7 +798,7 @@ changes: * `path` {string|Buffer|URL} * `mode` {integer} **Default:** `fs.constants.F_OK` -* Returns: `undefined` +* Returns: {undefined} Synchronously tests a user's permissions for the file or directory specified by `path`. The `mode` argument is an optional integer that specifies the diff --git a/doc/api/http2.md b/doc/api/http2.md index b70b2c4c46..7dbf89aedc 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -770,7 +770,7 @@ they respectively default to: added: v8.4.0 --> -* Extends: {Duplex} +* Extends: {stream.Duplex} Each instance of the `Http2Stream` class represents a bidirectional HTTP/2 communications stream over an `Http2Session` instance. Any single `Http2Session` diff --git a/doc/api/process.md b/doc/api/process.md index 405d629635..fc2a450f98 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -659,7 +659,7 @@ changes: * `module` {Object} * `filename` {string} -* `flags` {os.constants.dlopen}. Defaults to `os.constants.dlopen.RTLD_LAZY`. +* `flags` {os.constants.dlopen} Defaults to `os.constants.dlopen.RTLD_LAZY`. The `process.dlopen()` method allows to dynamically load shared objects. It is primarily used by `require()` to load diff --git a/doc/api/readline.md b/doc/api/readline.md index 7ba1277dce..42d07da2d0 100644 --- a/doc/api/readline.md +++ b/doc/api/readline.md @@ -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 @@ -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. @@ -362,9 +362,9 @@ changes: --> * `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. @@ -444,7 +444,7 @@ function completer(linePartial, callback) { added: v0.7.7 --> -* `stream` {Writable} +* `stream` {stream.Writable} * `x` {number} * `y` {number} @@ -456,7 +456,7 @@ given [TTY][] `stream`. added: v0.7.7 --> -* `stream` {Readable} +* `stream` {stream.Readable} * `interface` {readline.Interface} The `readline.emitKeypressEvents()` method causes the given [Readable][] @@ -482,7 +482,7 @@ if (process.stdin.isTTY) added: v0.7.7 --> -* `stream` {Writable} +* `stream` {stream.Writable} * `dx` {number} * `dy` {number} diff --git a/doc/api/repl.md b/doc/api/repl.md index a1dfffa9cc..506f54a4b8 100644 --- a/doc/api/repl.md +++ b/doc/api/repl.md @@ -412,9 +412,9 @@ changes: * `options` {Object|string} * `prompt` {string} The input prompt to display. Defaults to `> ` (with a trailing space). - * `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. diff --git a/doc/api/stream.md b/doc/api/stream.md index 222f8dbd49..e3f1761165 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -394,7 +394,7 @@ changes: --> * `encoding` {string} The new default encoding -* Returns: `this` +* Returns: {this} The `writable.setDefaultEncoding()` method sets the default `encoding` for a [Writable][] stream. @@ -533,7 +533,7 @@ A Writable stream in object mode will always ignore the `encoding` argument. added: v8.0.0 --> -* Returns: `this` +* Returns: {this} Destroy the stream, and emit the passed error. After this call, the writable stream has ended. Implementors should not override this method, @@ -824,7 +824,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 @@ -973,7 +973,7 @@ the status of the `highWaterMark`. 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. @@ -996,7 +996,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. diff --git a/doc/api/tty.md b/doc/api/tty.md index ce6dbae8fa..64612477fc 100644 --- a/doc/api/tty.md +++ b/doc/api/tty.md @@ -126,7 +126,7 @@ is updated whenever the `'resize'` event is emitted. added: REPLACEME --> -* `env` {object} A object containing the environment variables to check. +* `env` {Object} A object containing the environment variables to check. Defaults to `process.env`. * Returns: {number} |