diff options
author | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2018-04-08 16:53:47 +0300 |
---|---|---|
committer | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2018-04-11 14:11:29 +0300 |
commit | b3bff41690dbbb937d20b7f2c484b72b1f8e3440 (patch) | |
tree | ec61a1ba78a11f1314d1fabbd2bf655b51e98c53 /doc | |
parent | 96e82beac353c2607228590b49b3d232d33a64bf (diff) | |
download | android-node-v8-b3bff41690dbbb937d20b7f2c484b72b1f8e3440.tar.gz android-node-v8-b3bff41690dbbb937d20b7f2c484b72b1f8e3440.tar.bz2 android-node-v8-b3bff41690dbbb937d20b7f2c484b72b1f8e3440.zip |
doc, tools: make type parsing more strict
PR-URL: https://github.com/nodejs/node/pull/19881
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/addons.md | 6 | ||||
-rw-r--r-- | doc/api/deprecations.md | 7 | ||||
-rw-r--r-- | doc/api/http2.md | 4 | ||||
-rw-r--r-- | doc/api/process.md | 6 |
4 files changed, 13 insertions, 10 deletions
diff --git a/doc/api/addons.md b/doc/api/addons.md index e52e43153e..16040e8535 100644 --- a/doc/api/addons.md +++ b/doc/api/addons.md @@ -1096,8 +1096,10 @@ has ended but before the JavaScript VM is terminated and Node.js shuts down. #### void AtExit(callback, args) -* `callback` {void (\*)(void\*)} A pointer to the function to call at exit. -* `args` {void\*} A pointer to pass to the callback at exit. +* `callback` <span class="type"><void (\*)(void\*)></span> + A pointer to the function to call at exit. +* `args` <span class="type"><void\*></span> + A pointer to pass to the callback at exit. Registers exit hooks that run after the event loop has ended but before the VM is killed. diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index b78244b5d5..0a22723c65 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -890,12 +890,13 @@ should start using the `async_context` variant of `MakeCallback` or `CallbackScope`, or the high-level `AsyncResource` class. <a id="DEP0098"></a> -### DEP0098: AsyncHooks Embedder AsyncResource.emit{Before,After} APIs +### DEP0098: AsyncHooks Embedder AsyncResource.emitBefore and AsyncResource.emitAfter APIs Type: Runtime -The embedded API provided by AsyncHooks exposes emit{Before,After} methods -which are very easy to use incorrectly which can lead to unrecoverable errors. +The embedded API provided by AsyncHooks exposes `.emitBefore()` and +`.emitAfter()` methods which are very easy to use incorrectly which can lead +to unrecoverable errors. Use [`asyncResource.runInAsyncScope()`][] API instead which provides a much safer, and more convenient, alternative. See diff --git a/doc/api/http2.md b/doc/api/http2.md index 1c4980cb8b..4bb62e9124 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -2532,7 +2532,7 @@ authentication details. added: v8.4.0 --> -* {http2.Http2Stream} +* {Http2Stream} The [`Http2Stream`][] object backing the request. @@ -2948,7 +2948,7 @@ an empty string. added: v8.4.0 --> -* {http2.Http2Stream} +* {Http2Stream} The [`Http2Stream`][] object backing the response. diff --git a/doc/api/process.md b/doc/api/process.md index e80e187cc1..c454d67574 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -89,8 +89,8 @@ the child process. The listener callback is invoked with the following arguments: * `message` {Object} a parsed JSON object or primitive value. -* `sendHandle` {Handle object} a [`net.Socket`][] or [`net.Server`][] object, or - undefined. +* `sendHandle` {net.Server|net.Socket} a [`net.Server`][] or [`net.Socket`][] + object, or undefined. The message goes through serialization and parsing. The resulting message might not be the same as what is originally sent. @@ -1531,7 +1531,7 @@ added: v0.5.9 --> * `message` {Object} -* `sendHandle` {Handle object} +* `sendHandle` {net.Server|net.Socket} * `options` {Object} * `callback` {Function} * Returns: {boolean} |