mirror of https://github.com/lukechilds/node.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
100 lines
3.4 KiB
100 lines
3.4 KiB
'use strict';
|
|
const nodeDocUrl = '';
|
|
const jsDocPrefix = 'https://developer.mozilla.org/en-US/docs/Web/JavaScript/';
|
|
const jsDocUrl = `${jsDocPrefix}Reference/Global_Objects/`;
|
|
const jsPrimitiveUrl = `${jsDocPrefix}Data_structures`;
|
|
const jsPrimitives = {
|
|
'boolean': 'Boolean',
|
|
'integer': 'Number', // not a primitive, used for clarification
|
|
'null': 'Null',
|
|
'number': 'Number',
|
|
'string': 'String',
|
|
'symbol': 'Symbol',
|
|
'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', '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',
|
|
|
|
'ChildProcess': 'child_process.html#child_process_class_childprocess',
|
|
|
|
'cluster.Worker': 'cluster.html#cluster_class_worker',
|
|
|
|
'dgram.Socket': 'dgram.html#dgram_class_dgram_socket',
|
|
|
|
'EventEmitter': 'events.html#events_class_eventemitter',
|
|
|
|
'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.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 = {
|
|
toLink: function(typeInput) {
|
|
const typeLinks = [];
|
|
typeInput = typeInput.replace('{', '').replace('}', '');
|
|
const typeTexts = typeInput.split('|');
|
|
|
|
typeTexts.forEach(function(typeText) {
|
|
typeText = typeText.trim();
|
|
if (typeText) {
|
|
let typeUrl = null;
|
|
|
|
// To support type[], we store the full string and use
|
|
// the bracket-less version to lookup the type URL
|
|
const typeTextFull = typeText;
|
|
if (/\[]$/.test(typeText)) {
|
|
typeText = typeText.slice(0, -2);
|
|
}
|
|
|
|
const primitive = jsPrimitives[typeText.toLowerCase()];
|
|
|
|
if (primitive !== undefined) {
|
|
typeUrl = `${jsPrimitiveUrl}#${primitive}_type`;
|
|
} else if (jsGlobalTypes.indexOf(typeText) !== -1) {
|
|
typeUrl = jsDocUrl + typeText;
|
|
} else if (typeMap[typeText]) {
|
|
typeUrl = nodeDocUrl + typeMap[typeText];
|
|
}
|
|
|
|
if (typeUrl) {
|
|
typeLinks.push(`
|
|
<a href="${typeUrl}" class="type"><${typeTextFull}></a>`);
|
|
} else {
|
|
typeLinks.push(`<span class="type"><${typeTextFull}></span>`);
|
|
}
|
|
}
|
|
});
|
|
|
|
return typeLinks.length ? typeLinks.join(' | ') : typeInput;
|
|
}
|
|
};
|
|
|