Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/tools
diff options
context:
space:
mode:
authorOuyang Yadong <oyydoibh@gmail.com>2018-10-31 11:53:38 +0300
committerVse Mozhet Byt <vsemozhetbyt@gmail.com>2018-11-02 01:36:40 +0300
commit5689d553920e6276065517966fcaf8e02f498fc1 (patch)
tree56bf834f563b1767b753e6d3693c8bcd8d87a209 /tools
parent98819dfa5853d7c8355d70aa1aa7783677c391e5 (diff)
doc: add types and their corresponding return values
This commit supplements some types and their corresponding return values in docs, including `AsyncResource`, `DiffieHellman`, `ECDH`, `https.Server`, `repl.REPLServer`. PR-URL: https://github.com/nodejs/node/pull/23998 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Diffstat (limited to 'tools')
-rw-r--r--tools/doc/type-parser.js7
1 files changed, 7 insertions, 0 deletions
diff --git a/tools/doc/type-parser.js b/tools/doc/type-parser.js
index b57dc6957a9..49d888e88b9 100644
--- a/tools/doc/type-parser.js
+++ b/tools/doc/type-parser.js
@@ -36,6 +36,7 @@ const customTypesMap = {
`${jsDocPrefix}Reference/Iteration_protocols#The_iterator_protocol`,
'AsyncHook': 'async_hooks.html#async_hooks_async_hooks_createhook_callbacks',
+ 'AsyncResource': 'async_hooks.html#async_hooks_class_asyncresource',
'Buffer': 'buffer.html#buffer_class_buffer',
@@ -45,6 +46,8 @@ const customTypesMap = {
'Cipher': 'crypto.html#crypto_class_cipher',
'Decipher': 'crypto.html#crypto_class_decipher',
+ 'DiffieHellman': 'crypto.html#crypto_class_diffiehellman',
+ 'ECDH': 'crypto.html#crypto_class_ecdh',
'Hash': 'crypto.html#crypto_class_hash',
'Hmac': 'crypto.html#crypto_class_hmac',
'Sign': 'crypto.html#crypto_class_sign',
@@ -83,6 +86,8 @@ const customTypesMap = {
'Http2Stream': 'http2.html#http2_class_http2stream',
'ServerHttp2Stream': 'http2.html#http2_class_serverhttp2stream',
+ 'https.Server': 'https.html#https_class_https_server',
+
'module': 'modules.html#modules_the_module_object',
'Handle': 'net.html#net_server_listen_handle_backlog_callback',
@@ -101,6 +106,8 @@ const customTypesMap = {
'readline.Interface': 'readline.html#readline_class_interface',
+ 'repl.REPLServer': 'repl.html#repl_class_replserver',
+
'Stream': 'stream.html#stream_stream',
'stream.Duplex': 'stream.html#stream_class_stream_duplex',
'stream.Readable': 'stream.html#stream_class_stream_readable',