diff --git a/lib/http.js b/lib/http.js index 491162f9c4a172..38f1297be7921f 100644 --- a/lib/http.js +++ b/lib/http.js @@ -44,14 +44,65 @@ const { } = require('_http_server'); let maxHeaderSize; +/** + * Returns a new instance of `http.Server`. + * @param {{ + * IncomingMessage?: IncomingMessage; + * ServerResponse?: ServerResponse; + * insecureHTTPParser?: boolean; + * maxHeaderSize?: number; + * }} [opts] + * @param {Function} [requestListener] + * @returns {Server} + */ function createServer(opts, requestListener) { return new Server(opts, requestListener); } +/** + * @typedef {Object} HTTPRequestOptions + * @property {httpAgent.Agent | boolean} [agent] + * @property {string} [auth] + * @property {Function} [createConnection] + * @property {number} [defaultPort] + * @property {number} [family] + * @property {Object} [headers] + * @property {number} [hints] + * @property {string} [host] + * @property {string} [hostname] + * @property {boolean} [insecureHTTPParser] + * @property {string} [localAddress] + * @property {number} [localPort] + * @property {Function} [lookup] + * @property {number} [maxHeaderSize] + * @property {string} [method] + * @property {string} [path] + * @property {number} [port] + * @property {string} [protocol] + * @property {boolean} [setHost] + * @property {string} [socketPath] + * @property {number} [timeout] + * @property {AbortSignal} [signal] + */ + +/** + * Makes an HTTP request. + * @param {string | URL} url + * @param {HTTPRequestOptions} [options] + * @param {Function} [cb] + * @returns {ClientRequest} + */ function request(url, options, cb) { return new ClientRequest(url, options, cb); } +/** + * Makes a `GET` HTTP request. + * @param {string | URL} url + * @param {HTTPRequestOptions} [options] + * @param {Function} [cb] + * @returns {ClientRequest} + */ function get(url, options, cb) { const req = request(url, options, cb); req.end();