1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

tools/doc: add more intrinsic and custom types

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/11330
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
This commit is contained in:
Timothy Gu 2017-02-12 12:21:35 -08:00
parent e2d7df6fdc
commit 6cea5dd39f
1 changed files with 27 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
tools/doc/type-parser.js
View File

@ -16,31 +16,45 @@ const jsGlobalTypes = [
'Uint16Array', 'Uint32Array', 'Int8Array', 'Int16Array', 'Int32Array',
'Uint8ClampedArray', 'Float32Array', 'Float64Array', 'Date', 'RegExp',
'ArrayBuffer', 'DataView', 'Promise', 'EvalError', 'RangeError',
'ReferenceError', 'SyntaxError', 'TypeError', 'URIError'
'ReferenceError', 'SyntaxError', 'TypeError', 'URIError', 'Proxy', 'Map',
'Set', 'WeakMap', 'WeakSet', 'Generator', 'GeneratorFunction',
'AsyncFunction', 'SharedArrayBuffer'
];
const typeMap = {
'Iterable': jsDocPrefix +
'Reference/Iteration_protocols#The_iterable_protocol',
'Iterator': jsDocPrefix +
'Reference/Iteration_protocols#The_iterator_protocol',
'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',
'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',
'EventEmitter': 'events.html#events_class_eventemitter',
'Timer': 'timers.html#timers_timers',
'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',
'Iterable': jsDocPrefix +
'Reference/Iteration_protocols#The_iterable_protocol',
'Iterator': jsDocPrefix +
'Reference/Iteration_protocols#The_iterator_protocol',
'URL': 'url.html#url_the_whatwg_url_api'
'Handle': 'net.html#net_server_listen_handle_backlog_callback',
'net.Socket': 'net.html#net_class_net_socket',
'Stream': 'stream.html#stream_stream',
'stream.Readable': 'stream.html#stream_class_stream_readable',
'stream.Writable': 'stream.html#stream_class_stream_writable',
'tls.TLSSocket': 'tls.html#tls_class_tls_tlssocket',
'Timer': 'timers.html#timers_timers',
'URL': 'url.html#url_the_whatwg_url_api',
'URLSearchParams': 'url.html#url_class_urlsearchparams'
};
module.exports = {