1<!DOCTYPE html> 2<html lang="en"> 3<head> 4 <meta charset="utf-8"> 5 <meta name="viewport" content="width=device-width"> 6 <meta name="nodejs.org:node-version" content="v14.20.1"> 7 <title>HTTP | Node.js v14.20.1 Documentation</title> 8 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700,400italic&display=fallback"> 9 <link rel="stylesheet" href="assets/style.css"> 10 <link rel="stylesheet" href="assets/hljs.css"> 11 <link rel="canonical" href="https://nodejs.org/api/http.html"> 12</head> 13<body class="alt apidoc" id="api-section-http"> 14 <div id="content" class="clearfix"> 15 <div id="column2" class="interior"> 16 <div id="intro" class="interior"> 17 <a href="/" title="Go back to the home page"> 18 Node.js 19 </a> 20 </div> 21 <ul> 22<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li> 23<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> 24</ul> 25<hr class="line"> 26<ul> 27<li><a href="assert.html" class="nav-assert">Assertion testing</a></li> 28<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> 29<li><a href="buffer.html" class="nav-buffer">Buffer</a></li> 30<li><a href="addons.html" class="nav-addons">C++ addons</a></li> 31<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> 32<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li> 33<li><a href="child_process.html" class="nav-child_process">Child processes</a></li> 34<li><a href="cluster.html" class="nav-cluster">Cluster</a></li> 35<li><a href="cli.html" class="nav-cli">Command-line options</a></li> 36<li><a href="console.html" class="nav-console">Console</a></li> 37<li><a href="corepack.html" class="nav-corepack">Corepack</a></li> 38<li><a href="crypto.html" class="nav-crypto">Crypto</a></li> 39<li><a href="debugger.html" class="nav-debugger">Debugger</a></li> 40<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> 41<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> 42<li><a href="dns.html" class="nav-dns">DNS</a></li> 43<li><a href="domain.html" class="nav-domain">Domain</a></li> 44<li><a href="errors.html" class="nav-errors">Errors</a></li> 45<li><a href="events.html" class="nav-events">Events</a></li> 46<li><a href="fs.html" class="nav-fs">File system</a></li> 47<li><a href="globals.html" class="nav-globals">Globals</a></li> 48<li><a href="http.html" class="nav-http active">HTTP</a></li> 49<li><a href="http2.html" class="nav-http2">HTTP/2</a></li> 50<li><a href="https.html" class="nav-https">HTTPS</a></li> 51<li><a href="inspector.html" class="nav-inspector">Inspector</a></li> 52<li><a href="intl.html" class="nav-intl">Internationalization</a></li> 53<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> 54<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> 55<li><a href="module.html" class="nav-module">Modules: <code>module</code> API</a></li> 56<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> 57<li><a href="net.html" class="nav-net">Net</a></li> 58<li><a href="os.html" class="nav-os">OS</a></li> 59<li><a href="path.html" class="nav-path">Path</a></li> 60<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> 61<li><a href="policy.html" class="nav-policy">Policies</a></li> 62<li><a href="process.html" class="nav-process">Process</a></li> 63<li><a href="punycode.html" class="nav-punycode">Punycode</a></li> 64<li><a href="querystring.html" class="nav-querystring">Query strings</a></li> 65<li><a href="readline.html" class="nav-readline">Readline</a></li> 66<li><a href="repl.html" class="nav-repl">REPL</a></li> 67<li><a href="report.html" class="nav-report">Report</a></li> 68<li><a href="stream.html" class="nav-stream">Stream</a></li> 69<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li> 70<li><a href="timers.html" class="nav-timers">Timers</a></li> 71<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> 72<li><a href="tracing.html" class="nav-tracing">Trace events</a></li> 73<li><a href="tty.html" class="nav-tty">TTY</a></li> 74<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> 75<li><a href="url.html" class="nav-url">URL</a></li> 76<li><a href="util.html" class="nav-util">Utilities</a></li> 77<li><a href="v8.html" class="nav-v8">V8</a></li> 78<li><a href="vm.html" class="nav-vm">VM</a></li> 79<li><a href="wasi.html" class="nav-wasi">WASI</a></li> 80<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> 81<li><a href="zlib.html" class="nav-zlib">Zlib</a></li> 82</ul> 83<hr class="line"> 84<ul> 85<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> 86</ul> 87 </div> 88 89 <div id="column1" data-id="http" class="interior"> 90 <header> 91 <div class="header-container"> 92 <h1>Node.js v14.20.1 documentation</h1> 93 <button class="theme-toggle-btn" id="theme-toggle-btn" title="Toggle dark mode/light mode" aria-label="Toggle dark mode/light mode" hidden> 94 <svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" height="24" width="24"> 95 <path fill="none" d="M0 0h24v24H0z" /> 96 <path d="M11.1 12.08c-2.33-4.51-.5-8.48.53-10.07C6.27 2.2 1.98 6.59 1.98 12c0 .14.02.28.02.42.62-.27 1.29-.42 2-.42 1.66 0 3.18.83 4.1 2.15A4.01 4.01 0 0111 18c0 1.52-.87 2.83-2.12 3.51.98.32 2.03.5 3.11.5 3.5 0 6.58-1.8 8.37-4.52-2.36.23-6.98-.97-9.26-5.41z"/> 97 <path d="M7 16h-.18C6.4 14.84 5.3 14 4 14c-1.66 0-3 1.34-3 3s1.34 3 3 3h3c1.1 0 2-.9 2-2s-.9-2-2-2z"/> 98 </svg> 99 <svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" height="24" width="24"> 100 <path d="M0 0h24v24H0z" fill="none" /> 101 <path d="M6.76 4.84l-1.8-1.79-1.41 1.41 1.79 1.79 1.42-1.41zM4 10.5H1v2h3v-2zm9-9.95h-2V3.5h2V.55zm7.45 3.91l-1.41-1.41-1.79 1.79 1.41 1.41 1.79-1.79zm-3.21 13.7l1.79 1.8 1.41-1.41-1.8-1.79-1.4 1.4zM20 10.5v2h3v-2h-3zm-8-5c-3.31 0-6 2.69-6 6s2.69 6 6 6 6-2.69 6-6-2.69-6-6-6zm-1 16.95h2V19.5h-2v2.95zm-7.45-3.91l1.41 1.41 1.79-1.8-1.41-1.41-1.79 1.8z"/> 102 </svg> 103 </button> 104 </div> 105 <div id="gtoc"> 106 <ul> 107 <li> 108 <a href="index.html">Index</a> 109 </li> 110 <li> 111 <a href="all.html">View on single page</a> 112 </li> 113 <li> 114 <a href="http.json">View as JSON</a> 115 </li> 116 117 <li class="version-picker"> 118 <a href="#">View another version <span>▼</span></a> 119 <ol class="version-picker"><li><a href="https://nodejs.org/docs/latest-v18.x/api/http.html">18.x</a></li> 120<li><a href="https://nodejs.org/docs/latest-v17.x/api/http.html">17.x</a></li> 121<li><a href="https://nodejs.org/docs/latest-v16.x/api/http.html">16.x <b>LTS</b></a></li> 122<li><a href="https://nodejs.org/docs/latest-v15.x/api/http.html">15.x</a></li> 123<li><a href="https://nodejs.org/docs/latest-v14.x/api/http.html">14.x <b>LTS</b></a></li> 124<li><a href="https://nodejs.org/docs/latest-v13.x/api/http.html">13.x</a></li> 125<li><a href="https://nodejs.org/docs/latest-v12.x/api/http.html">12.x <b>LTS</b></a></li> 126<li><a href="https://nodejs.org/docs/latest-v11.x/api/http.html">11.x</a></li> 127<li><a href="https://nodejs.org/docs/latest-v10.x/api/http.html">10.x</a></li> 128<li><a href="https://nodejs.org/docs/latest-v9.x/api/http.html">9.x</a></li> 129<li><a href="https://nodejs.org/docs/latest-v8.x/api/http.html">8.x</a></li> 130<li><a href="https://nodejs.org/docs/latest-v7.x/api/http.html">7.x</a></li> 131<li><a href="https://nodejs.org/docs/latest-v6.x/api/http.html">6.x</a></li> 132<li><a href="https://nodejs.org/docs/latest-v5.x/api/http.html">5.x</a></li> 133<li><a href="https://nodejs.org/docs/latest-v4.x/api/http.html">4.x</a></li> 134<li><a href="https://nodejs.org/docs/latest-v0.12.x/api/http.html">0.12.x</a></li> 135<li><a href="https://nodejs.org/docs/latest-v0.10.x/api/http.html">0.10.x</a></li></ol> 136 </li> 137 138 <li class="edit_on_github"><a href="https://github.com/nodejs/node/edit/master/doc/api/http.md">Edit on GitHub</a></li> 139 </ul> 140 </div> 141 <hr> 142 </header> 143 144 <details id="toc" open><summary>Table of contents</summary><ul> 145<li><span class="stability_2"><a href="#http_http">HTTP</a></span> 146<ul> 147<li><a href="#http_class_http_agent">Class: <code>http.Agent</code></a> 148<ul> 149<li><a href="#http_new_agent_options"><code>new Agent([options])</code></a></li> 150<li><a href="#http_agent_createconnection_options_callback"><code>agent.createConnection(options[, callback])</code></a></li> 151<li><a href="#http_agent_keepsocketalive_socket"><code>agent.keepSocketAlive(socket)</code></a></li> 152<li><a href="#http_agent_reusesocket_socket_request"><code>agent.reuseSocket(socket, request)</code></a></li> 153<li><a href="#http_agent_destroy"><code>agent.destroy()</code></a></li> 154<li><a href="#http_agent_freesockets"><code>agent.freeSockets</code></a></li> 155<li><a href="#http_agent_getname_options"><code>agent.getName(options)</code></a></li> 156<li><a href="#http_agent_maxfreesockets"><code>agent.maxFreeSockets</code></a></li> 157<li><a href="#http_agent_maxsockets"><code>agent.maxSockets</code></a></li> 158<li><a href="#http_agent_maxtotalsockets"><code>agent.maxTotalSockets</code></a></li> 159<li><a href="#http_agent_requests"><code>agent.requests</code></a></li> 160<li><a href="#http_agent_sockets"><code>agent.sockets</code></a></li> 161</ul> 162</li> 163<li><a href="#http_class_http_clientrequest">Class: <code>http.ClientRequest</code></a> 164<ul> 165<li><a href="#http_event_abort">Event: <code>'abort'</code></a></li> 166<li><a href="#http_event_connect">Event: <code>'connect'</code></a></li> 167<li><a href="#http_event_continue">Event: <code>'continue'</code></a></li> 168<li><a href="#http_event_information">Event: <code>'information'</code></a></li> 169<li><a href="#http_event_response">Event: <code>'response'</code></a></li> 170<li><a href="#http_event_socket">Event: <code>'socket'</code></a></li> 171<li><a href="#http_event_timeout">Event: <code>'timeout'</code></a></li> 172<li><a href="#http_event_upgrade">Event: <code>'upgrade'</code></a></li> 173<li><span class="stability_0"><a href="#http_request_abort"><code>request.abort()</code></a></span></li> 174<li><a href="#http_request_aborted"><code>request.aborted</code></a></li> 175<li><span class="stability_0"><a href="#http_request_connection"><code>request.connection</code></a></span></li> 176<li><a href="#http_request_end_data_encoding_callback"><code>request.end([data[, encoding]][, callback])</code></a></li> 177<li><a href="#http_request_destroy_error"><code>request.destroy([error])</code></a> 178<ul> 179<li><a href="#http_request_destroyed"><code>request.destroyed</code></a></li> 180</ul> 181</li> 182<li><span class="stability_0"><a href="#http_request_finished"><code>request.finished</code></a></span></li> 183<li><a href="#http_request_flushheaders"><code>request.flushHeaders()</code></a></li> 184<li><a href="#http_request_getheader_name"><code>request.getHeader(name)</code></a></li> 185<li><a href="#http_request_getrawheadernames"><code>request.getRawHeaderNames()</code></a></li> 186<li><a href="#http_request_maxheaderscount"><code>request.maxHeadersCount</code></a></li> 187<li><a href="#http_request_path"><code>request.path</code></a></li> 188<li><a href="#http_request_method"><code>request.method</code></a></li> 189<li><a href="#http_request_host"><code>request.host</code></a></li> 190<li><a href="#http_request_protocol"><code>request.protocol</code></a></li> 191<li><a href="#http_request_removeheader_name"><code>request.removeHeader(name)</code></a></li> 192<li><a href="#http_request_reusedsocket"><code>request.reusedSocket</code></a></li> 193<li><a href="#http_request_setheader_name_value"><code>request.setHeader(name, value)</code></a></li> 194<li><a href="#http_request_setnodelay_nodelay"><code>request.setNoDelay([noDelay])</code></a></li> 195<li><a href="#http_request_setsocketkeepalive_enable_initialdelay"><code>request.setSocketKeepAlive([enable][, initialDelay])</code></a></li> 196<li><a href="#http_request_settimeout_timeout_callback"><code>request.setTimeout(timeout[, callback])</code></a></li> 197<li><a href="#http_request_socket"><code>request.socket</code></a></li> 198<li><a href="#http_request_writableended"><code>request.writableEnded</code></a></li> 199<li><a href="#http_request_writablefinished"><code>request.writableFinished</code></a></li> 200<li><a href="#http_request_write_chunk_encoding_callback"><code>request.write(chunk[, encoding][, callback])</code></a></li> 201</ul> 202</li> 203<li><a href="#http_class_http_server">Class: <code>http.Server</code></a> 204<ul> 205<li><a href="#http_event_checkcontinue">Event: <code>'checkContinue'</code></a></li> 206<li><a href="#http_event_checkexpectation">Event: <code>'checkExpectation'</code></a></li> 207<li><a href="#http_event_clienterror">Event: <code>'clientError'</code></a></li> 208<li><a href="#http_event_close">Event: <code>'close'</code></a></li> 209<li><a href="#http_event_connect_1">Event: <code>'connect'</code></a></li> 210<li><a href="#http_event_connection">Event: <code>'connection'</code></a></li> 211<li><a href="#http_event_request">Event: <code>'request'</code></a></li> 212<li><a href="#http_event_upgrade_1">Event: <code>'upgrade'</code></a></li> 213<li><a href="#http_server_close_callback"><code>server.close([callback])</code></a></li> 214<li><a href="#http_server_headerstimeout"><code>server.headersTimeout</code></a></li> 215<li><a href="#http_server_listen"><code>server.listen()</code></a></li> 216<li><a href="#http_server_listening"><code>server.listening</code></a></li> 217<li><a href="#http_server_maxheaderscount"><code>server.maxHeadersCount</code></a></li> 218<li><a href="#http_server_requesttimeout"><code>server.requestTimeout</code></a></li> 219<li><a href="#http_server_settimeout_msecs_callback"><code>server.setTimeout([msecs][, callback])</code></a></li> 220<li><a href="#http_server_timeout"><code>server.timeout</code></a></li> 221<li><a href="#http_server_keepalivetimeout"><code>server.keepAliveTimeout</code></a></li> 222</ul> 223</li> 224<li><a href="#http_class_http_serverresponse">Class: <code>http.ServerResponse</code></a> 225<ul> 226<li><a href="#http_event_close_1">Event: <code>'close'</code></a></li> 227<li><a href="#http_event_finish">Event: <code>'finish'</code></a></li> 228<li><a href="#http_response_addtrailers_headers"><code>response.addTrailers(headers)</code></a></li> 229<li><span class="stability_0"><a href="#http_response_connection"><code>response.connection</code></a></span></li> 230<li><a href="#http_response_cork"><code>response.cork()</code></a></li> 231<li><a href="#http_response_end_data_encoding_callback"><code>response.end([data[, encoding]][, callback])</code></a></li> 232<li><span class="stability_0"><a href="#http_response_finished"><code>response.finished</code></a></span></li> 233<li><a href="#http_response_flushheaders"><code>response.flushHeaders()</code></a></li> 234<li><a href="#http_response_getheader_name"><code>response.getHeader(name)</code></a></li> 235<li><a href="#http_response_getheadernames"><code>response.getHeaderNames()</code></a></li> 236<li><a href="#http_response_getheaders"><code>response.getHeaders()</code></a></li> 237<li><a href="#http_response_hasheader_name"><code>response.hasHeader(name)</code></a></li> 238<li><a href="#http_response_headerssent"><code>response.headersSent</code></a></li> 239<li><a href="#http_response_removeheader_name"><code>response.removeHeader(name)</code></a></li> 240<li><a href="#http_response_senddate"><code>response.sendDate</code></a></li> 241<li><a href="#http_response_setheader_name_value"><code>response.setHeader(name, value)</code></a></li> 242<li><a href="#http_response_settimeout_msecs_callback"><code>response.setTimeout(msecs[, callback])</code></a></li> 243<li><a href="#http_response_socket"><code>response.socket</code></a></li> 244<li><a href="#http_response_statuscode"><code>response.statusCode</code></a></li> 245<li><a href="#http_response_statusmessage"><code>response.statusMessage</code></a></li> 246<li><a href="#http_response_uncork"><code>response.uncork()</code></a></li> 247<li><a href="#http_response_writableended"><code>response.writableEnded</code></a></li> 248<li><a href="#http_response_writablefinished"><code>response.writableFinished</code></a></li> 249<li><a href="#http_response_write_chunk_encoding_callback"><code>response.write(chunk[, encoding][, callback])</code></a></li> 250<li><a href="#http_response_writecontinue"><code>response.writeContinue()</code></a></li> 251<li><a href="#http_response_writehead_statuscode_statusmessage_headers"><code>response.writeHead(statusCode[, statusMessage][, headers])</code></a></li> 252<li><a href="#http_response_writeprocessing"><code>response.writeProcessing()</code></a></li> 253</ul> 254</li> 255<li><a href="#http_class_http_incomingmessage">Class: <code>http.IncomingMessage</code></a> 256<ul> 257<li><a href="#http_event_aborted">Event: <code>'aborted'</code></a></li> 258<li><a href="#http_event_close_2">Event: <code>'close'</code></a></li> 259<li><a href="#http_message_aborted"><code>message.aborted</code></a></li> 260<li><a href="#http_message_complete"><code>message.complete</code></a></li> 261<li><a href="#http_message_destroy_error"><code>message.destroy([error])</code></a></li> 262<li><a href="#http_message_headers"><code>message.headers</code></a></li> 263<li><a href="#http_message_httpversion"><code>message.httpVersion</code></a></li> 264<li><a href="#http_message_method"><code>message.method</code></a></li> 265<li><a href="#http_message_rawheaders"><code>message.rawHeaders</code></a></li> 266<li><a href="#http_message_rawtrailers"><code>message.rawTrailers</code></a></li> 267<li><a href="#http_message_settimeout_msecs_callback"><code>message.setTimeout(msecs[, callback])</code></a></li> 268<li><a href="#http_message_socket"><code>message.socket</code></a></li> 269<li><a href="#http_message_statuscode"><code>message.statusCode</code></a></li> 270<li><a href="#http_message_statusmessage"><code>message.statusMessage</code></a></li> 271<li><a href="#http_message_trailers"><code>message.trailers</code></a></li> 272<li><a href="#http_message_url"><code>message.url</code></a></li> 273</ul> 274</li> 275<li><a href="#http_class_http_outgoingmessage">Class: <code>http.OutgoingMessage</code></a> 276<ul> 277<li><a href="#http_event_drain">Event: <code>drain</code></a></li> 278<li><a href="#http_event_finish_1">Event: <code>finish</code></a></li> 279<li><a href="#http_event_prefinish">Event: <code>prefinish</code></a></li> 280<li><a href="#http_outgoingmessage_addtrailers_headers"><code>outgoingMessage.addTrailers(headers)</code></a></li> 281<li><span class="stability_0"><a href="#http_outgoingmessage_connection"><code>outgoingMessage.connection</code></a></span></li> 282<li><a href="#http_outgoingmessage_cork"><code>outgoingMessage.cork()</code></a></li> 283<li><a href="#http_outgoingmessage_destroy_error"><code>outgoingMessage.destroy([error])</code></a></li> 284<li><a href="#http_outgoingmessage_end_chunk_encoding_callback"><code>outgoingMessage.end(chunk[, encoding][, callback])</code></a></li> 285<li><a href="#http_outgoingmessage_flushheaders"><code>outgoingMessage.flushHeaders()</code></a></li> 286<li><a href="#http_outgoingmessage_getheader_name"><code>outgoingMessage.getHeader(name)</code></a></li> 287<li><a href="#http_outgoingmessage_getheadernames"><code>outgoingMessage.getHeaderNames()</code></a></li> 288<li><a href="#http_outgoingmessage_getheaders"><code>outgoingMessage.getHeaders()</code></a></li> 289<li><a href="#http_outgoingmessage_hasheader_name"><code>outgoingMessage.hasHeader(name)</code></a></li> 290<li><a href="#http_outgoingmessage_headerssent"><code>outgoingMessage.headersSent</code></a></li> 291<li><a href="#http_outgoingmessage_pipe"><code>outgoingMessage.pipe()</code></a></li> 292<li><a href="#http_outgoingmessage_removeheader"><code>outgoingMessage.removeHeader()</code></a></li> 293<li><a href="#http_outgoingmessage_setheader_name_value"><code>outgoingMessage.setHeader(name, value)</code></a></li> 294<li><a href="#http_outgoingmessage_settimeout_msesc_callback"><code>outgoingMessage.setTimeout(msesc[, callback])</code></a></li> 295<li><a href="#http_outgoingmessage_socket"><code>outgoingMessage.socket</code></a></li> 296<li><a href="#http_outgoingmessage_uncork"><code>outgoingMessage.uncork()</code></a></li> 297<li><a href="#http_outgoingmessage_writablecorked"><code>outgoingMessage.writableCorked</code></a></li> 298<li><a href="#http_outgoingmessage_writableended"><code>outgoingMessage.writableEnded</code></a></li> 299<li><a href="#http_outgoingmessage_writablefinished"><code>outgoingMessage.writableFinished</code></a></li> 300<li><a href="#http_outgoingmessage_writablehighwatermark"><code>outgoingMessage.writableHighWaterMark</code></a></li> 301<li><a href="#http_outgoingmessage_writablelength"><code>outgoingMessage.writableLength</code></a></li> 302<li><a href="#http_outgoingmessage_writableobjectmode"><code>outgoingMessage.writableObjectMode</code></a></li> 303<li><a href="#http_outgoingmessage_write_chunk_encoding_callback"><code>outgoingMessage.write(chunk[, encoding][, callback])</code></a></li> 304</ul> 305</li> 306<li><a href="#http_http_methods"><code>http.METHODS</code></a></li> 307<li><a href="#http_http_status_codes"><code>http.STATUS_CODES</code></a></li> 308<li><a href="#http_http_createserver_options_requestlistener"><code>http.createServer([options][, requestListener])</code></a></li> 309<li><a href="#http_http_get_options_callback"><code>http.get(options[, callback])</code></a></li> 310<li><a href="#http_http_get_url_options_callback"><code>http.get(url[, options][, callback])</code></a></li> 311<li><a href="#http_http_globalagent"><code>http.globalAgent</code></a></li> 312<li><a href="#http_http_maxheadersize"><code>http.maxHeaderSize</code></a></li> 313<li><a href="#http_http_request_options_callback"><code>http.request(options[, callback])</code></a></li> 314<li><a href="#http_http_request_url_options_callback"><code>http.request(url[, options][, callback])</code></a></li> 315<li><a href="#http_http_validateheadername_name"><code>http.validateHeaderName(name)</code></a></li> 316<li><a href="#http_http_validateheadervalue_name_value"><code>http.validateHeaderValue(name, value)</code></a></li> 317</ul> 318</li> 319</ul></details> 320 321 <div id="apicontent"> 322 <h2>HTTP<span><a class="mark" href="#http_http" id="http_http">#</a></span></h2> 323 324<p></p><div class="api_stability api_stability_2"><a href="documentation.html#documentation_stability_index">Stability: 2</a> - Stable</div><p></p> 325<p><strong>Source Code:</strong> <a href="https://github.com/nodejs/node/blob/v14.20.1/lib/http.js">lib/http.js</a></p> 326<p>To use the HTTP server and client one must <code>require('http')</code>.</p> 327<p>The HTTP interfaces in Node.js are designed to support many features 328of the protocol which have been traditionally difficult to use. 329In particular, large, possibly chunk-encoded, messages. The interface is 330careful to never buffer entire requests or responses, so the 331user is able to stream data.</p> 332<p>HTTP message headers are represented by an object like this:</p> 333<!-- eslint-skip --> 334<pre><code class="language-js">{ <span class="hljs-string">'content-length'</span>: <span class="hljs-string">'123'</span>, 335 <span class="hljs-string">'content-type'</span>: <span class="hljs-string">'text/plain'</span>, 336 <span class="hljs-string">'connection'</span>: <span class="hljs-string">'keep-alive'</span>, 337 <span class="hljs-string">'host'</span>: <span class="hljs-string">'mysite.com'</span>, 338 <span class="hljs-string">'accept'</span>: <span class="hljs-string">'*/*'</span> }</code></pre> 339<p>Keys are lowercased. Values are not modified.</p> 340<p>In order to support the full spectrum of possible HTTP applications, the Node.js 341HTTP API is very low-level. It deals with stream handling and message 342parsing only. It parses a message into headers and body but it does not 343parse the actual headers or the body.</p> 344<p>See <a href="#http_message_headers"><code>message.headers</code></a> for details on how duplicate headers are handled.</p> 345<p>The raw headers as they were received are retained in the <code>rawHeaders</code> 346property, which is an array of <code>[key, value, key2, value2, ...]</code>. For 347example, the previous message header object might have a <code>rawHeaders</code> 348list like the following:</p> 349<!-- eslint-disable semi --> 350<pre><code class="language-js">[ <span class="hljs-string">'ConTent-Length'</span>, <span class="hljs-string">'123456'</span>, 351 <span class="hljs-string">'content-LENGTH'</span>, <span class="hljs-string">'123'</span>, 352 <span class="hljs-string">'content-type'</span>, <span class="hljs-string">'text/plain'</span>, 353 <span class="hljs-string">'CONNECTION'</span>, <span class="hljs-string">'keep-alive'</span>, 354 <span class="hljs-string">'Host'</span>, <span class="hljs-string">'mysite.com'</span>, 355 <span class="hljs-string">'accepT'</span>, <span class="hljs-string">'*/*'</span> ]</code></pre> 356<section><h3>Class: <code>http.Agent</code><span><a class="mark" href="#http_class_http_agent" id="http_class_http_agent">#</a></span></h3> 357<div class="api_metadata"> 358<span>Added in: v0.3.4</span> 359</div> 360<p>An <code>Agent</code> is responsible for managing connection persistence 361and reuse for HTTP clients. It maintains a queue of pending requests 362for a given host and port, reusing a single socket connection for each 363until the queue is empty, at which time the socket is either destroyed 364or put into a pool where it is kept to be used again for requests to the 365same host and port. Whether it is destroyed or pooled depends on the 366<code>keepAlive</code> <a href="#http_new_agent_options">option</a>.</p> 367<p>Pooled connections have TCP Keep-Alive enabled for them, but servers may 368still close idle connections, in which case they will be removed from the 369pool and a new connection will be made when a new HTTP request is made for 370that host and port. Servers may also refuse to allow multiple requests 371over the same connection, in which case the connection will have to be 372remade for every request and cannot be pooled. The <code>Agent</code> will still make 373the requests to that server, but each one will occur over a new connection.</p> 374<p>When a connection is closed by the client or the server, it is removed 375from the pool. Any unused sockets in the pool will be unrefed so as not 376to keep the Node.js process running when there are no outstanding requests. 377(see <a href="net.html#net_socket_unref"><code>socket.unref()</code></a>).</p> 378<p>It is good practice, to <a href="#http_agent_destroy"><code>destroy()</code></a> an <code>Agent</code> instance when it is no 379longer in use, because unused sockets consume OS resources.</p> 380<p>Sockets are removed from an agent when the socket emits either 381a <code>'close'</code> event or an <code>'agentRemove'</code> event. When intending to keep one 382HTTP request open for a long time without keeping it in the agent, something 383like the following may be done:</p> 384<pre><code class="language-js">http.<span class="hljs-title function_">get</span>(options, <span class="hljs-function">(<span class="hljs-params">res</span>) =></span> { 385 <span class="hljs-comment">// Do stuff</span> 386}).<span class="hljs-title function_">on</span>(<span class="hljs-string">'socket'</span>, <span class="hljs-function">(<span class="hljs-params">socket</span>) =></span> { 387 socket.<span class="hljs-title function_">emit</span>(<span class="hljs-string">'agentRemove'</span>); 388});</code></pre> 389<p>An agent may also be used for an individual request. By providing 390<code>{agent: false}</code> as an option to the <code>http.get()</code> or <code>http.request()</code> 391functions, a one-time use <code>Agent</code> with default options will be used 392for the client connection.</p> 393<p><code>agent:false</code>:</p> 394<pre><code class="language-js">http.<span class="hljs-title function_">get</span>({ 395 <span class="hljs-attr">hostname</span>: <span class="hljs-string">'localhost'</span>, 396 <span class="hljs-attr">port</span>: <span class="hljs-number">80</span>, 397 <span class="hljs-attr">path</span>: <span class="hljs-string">'/'</span>, 398 <span class="hljs-attr">agent</span>: <span class="hljs-literal">false</span> <span class="hljs-comment">// Create a new agent just for this one request</span> 399}, <span class="hljs-function">(<span class="hljs-params">res</span>) =></span> { 400 <span class="hljs-comment">// Do stuff with response</span> 401});</code></pre> 402<h4><code>new Agent([options])</code><span><a class="mark" href="#http_new_agent_options" id="http_new_agent_options">#</a></span></h4> 403<div class="api_metadata"> 404<details class="changelog"><summary>History</summary> 405<table> 406<tbody><tr><th>Version</th><th>Changes</th></tr> 407<tr><td>v14.17.0</td> 408<td><p>Change the default scheduling from 'fifo' to 'lifo'.</p></td></tr> 409<tr><td>v14.5.0</td> 410<td><p>Add <code>maxTotalSockets</code> option to agent constructor.</p></td></tr> 411<tr><td>v14.5.0</td> 412<td><p>Add <code>scheduling</code> option to specify the free socket scheduling strategy.</p></td></tr> 413<tr><td>v0.3.4</td> 414<td><p><span>Added in: v0.3.4</span></p></td></tr> 415</tbody></table> 416</details> 417</div> 418<ul> 419<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> Set of configurable options to set on the agent. 420Can have the following fields: 421<ul> 422<li><code>keepAlive</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> Keep sockets around even when there are no 423outstanding requests, so they can be used for future requests without 424having to reestablish a TCP connection. Not to be confused with the 425<code>keep-alive</code> value of the <code>Connection</code> header. The <code>Connection: keep-alive</code> 426header is always sent when using an agent except when the <code>Connection</code> 427header is explicitly specified or when the <code>keepAlive</code> and <code>maxSockets</code> 428options are respectively set to <code>false</code> and <code>Infinity</code>, in which case 429<code>Connection: close</code> will be used. <strong>Default:</strong> <code>false</code>.</li> 430<li><code>keepAliveMsecs</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> When using the <code>keepAlive</code> option, specifies 431the <a href="net.html#net_socket_setkeepalive_enable_initialdelay">initial delay</a> 432for TCP Keep-Alive packets. Ignored when the 433<code>keepAlive</code> option is <code>false</code> or <code>undefined</code>. <strong>Default:</strong> <code>1000</code>.</li> 434<li><code>maxSockets</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Maximum number of sockets to allow per host. 435If the same host opens multiple concurrent connections, each request 436will use new socket until the <code>maxSockets</code> value is reached. 437If the host attempts to open more connections than <code>maxSockets</code>, 438the additional requests will enter into a pending request queue, and 439will enter active connection state when an existing connection terminates. 440This makes sure there are at most <code>maxSockets</code> active connections at 441any point in time, from a given host. 442<strong>Default:</strong> <code>Infinity</code>.</li> 443<li><code>maxTotalSockets</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Maximum number of sockets allowed for 444all hosts in total. Each request will use a new socket 445until the maximum is reached. 446<strong>Default:</strong> <code>Infinity</code>.</li> 447<li><code>maxFreeSockets</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Maximum number of sockets to leave open 448in a free state. Only relevant if <code>keepAlive</code> is set to <code>true</code>. 449<strong>Default:</strong> <code>256</code>.</li> 450<li><code>scheduling</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> Scheduling strategy to apply when picking 451the next free socket to use. It can be <code>'fifo'</code> or <code>'lifo'</code>. 452The main difference between the two scheduling strategies is that <code>'lifo'</code> 453selects the most recently used socket, while <code>'fifo'</code> selects 454the least recently used socket. 455In case of a low rate of request per second, the <code>'lifo'</code> scheduling 456will lower the risk of picking a socket that might have been closed 457by the server due to inactivity. 458In case of a high rate of request per second, 459the <code>'fifo'</code> scheduling will maximize the number of open sockets, 460while the <code>'lifo'</code> scheduling will keep it as low as possible. 461<strong>Default:</strong> <code>'lifo'</code>.</li> 462<li><code>timeout</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Socket timeout in milliseconds. 463This will set the timeout when the socket is created.</li> 464</ul> 465</li> 466</ul> 467<p><code>options</code> in <a href="net.html#net_socket_connect_options_connectlistener"><code>socket.connect()</code></a> are also supported.</p> 468<p>The default <a href="#http_http_globalagent"><code>http.globalAgent</code></a> that is used by <a href="#http_http_request_options_callback"><code>http.request()</code></a> has all 469of these values set to their respective defaults.</p> 470<p>To configure any of them, a custom <a href="#http_class_http_agent"><code>http.Agent</code></a> instance must be created.</p> 471<pre><code class="language-js"><span class="hljs-keyword">const</span> http = <span class="hljs-built_in">require</span>(<span class="hljs-string">'http'</span>); 472<span class="hljs-keyword">const</span> keepAliveAgent = <span class="hljs-keyword">new</span> http.<span class="hljs-title class_">Agent</span>({ <span class="hljs-attr">keepAlive</span>: <span class="hljs-literal">true</span> }); 473options.<span class="hljs-property">agent</span> = keepAliveAgent; 474http.<span class="hljs-title function_">request</span>(options, onResponseCallback);</code></pre> 475<h4><code>agent.createConnection(options[, callback])</code><span><a class="mark" href="#http_agent_createconnection_options_callback" id="http_agent_createconnection_options_callback">#</a></span></h4> 476<div class="api_metadata"> 477<span>Added in: v0.11.4</span> 478</div> 479<ul> 480<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> Options containing connection details. Check 481<a href="net.html#net_net_createconnection_options_connectlistener"><code>net.createConnection()</code></a> for the format of the options</li> 482<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> Callback function that receives the created socket</li> 483<li>Returns: <a href="stream.html#stream_class_stream_duplex" class="type"><stream.Duplex></a></li> 484</ul> 485<p>Produces a socket/stream to be used for HTTP requests.</p> 486<p>By default, this function is the same as <a href="net.html#net_net_createconnection_options_connectlistener"><code>net.createConnection()</code></a>. However, 487custom agents may override this method in case greater flexibility is desired.</p> 488<p>A socket/stream can be supplied in one of two ways: by returning the 489socket/stream from this function, or by passing the socket/stream to <code>callback</code>.</p> 490<p>This method is guaranteed to return an instance of the <a href="net.html#net_class_net_socket" class="type"><net.Socket></a> class, 491a subclass of <a href="stream.html#stream_class_stream_duplex" class="type"><stream.Duplex></a>, unless the user specifies a socket 492type other than <a href="net.html#net_class_net_socket" class="type"><net.Socket></a>.</p> 493<p><code>callback</code> has a signature of <code>(err, stream)</code>.</p> 494<h4><code>agent.keepSocketAlive(socket)</code><span><a class="mark" href="#http_agent_keepsocketalive_socket" id="http_agent_keepsocketalive_socket">#</a></span></h4> 495<div class="api_metadata"> 496<span>Added in: v8.1.0</span> 497</div> 498<ul> 499<li><code>socket</code> <a href="stream.html#stream_class_stream_duplex" class="type"><stream.Duplex></a></li> 500</ul> 501<p>Called when <code>socket</code> is detached from a request and could be persisted by the 502<code>Agent</code>. Default behavior is to:</p> 503<pre><code class="language-js">socket.<span class="hljs-title function_">setKeepAlive</span>(<span class="hljs-literal">true</span>, <span class="hljs-variable language_">this</span>.<span class="hljs-property">keepAliveMsecs</span>); 504socket.<span class="hljs-title function_">unref</span>(); 505<span class="hljs-keyword">return</span> <span class="hljs-literal">true</span>;</code></pre> 506<p>This method can be overridden by a particular <code>Agent</code> subclass. If this 507method returns a falsy value, the socket will be destroyed instead of persisting 508it for use with the next request.</p> 509<p>The <code>socket</code> argument can be an instance of <a href="net.html#net_class_net_socket" class="type"><net.Socket></a>, a subclass of 510<a href="stream.html#stream_class_stream_duplex" class="type"><stream.Duplex></a>.</p> 511<h4><code>agent.reuseSocket(socket, request)</code><span><a class="mark" href="#http_agent_reusesocket_socket_request" id="http_agent_reusesocket_socket_request">#</a></span></h4> 512<div class="api_metadata"> 513<span>Added in: v8.1.0</span> 514</div> 515<ul> 516<li><code>socket</code> <a href="stream.html#stream_class_stream_duplex" class="type"><stream.Duplex></a></li> 517<li><code>request</code> <a href="http.html#http_class_http_clientrequest" class="type"><http.ClientRequest></a></li> 518</ul> 519<p>Called when <code>socket</code> is attached to <code>request</code> after being persisted because of 520the keep-alive options. Default behavior is to:</p> 521<pre><code class="language-js">socket.<span class="hljs-title function_">ref</span>();</code></pre> 522<p>This method can be overridden by a particular <code>Agent</code> subclass.</p> 523<p>The <code>socket</code> argument can be an instance of <a href="net.html#net_class_net_socket" class="type"><net.Socket></a>, a subclass of 524<a href="stream.html#stream_class_stream_duplex" class="type"><stream.Duplex></a>.</p> 525<h4><code>agent.destroy()</code><span><a class="mark" href="#http_agent_destroy" id="http_agent_destroy">#</a></span></h4> 526<div class="api_metadata"> 527<span>Added in: v0.11.4</span> 528</div> 529<p>Destroy any sockets that are currently in use by the agent.</p> 530<p>It is usually not necessary to do this. However, if using an 531agent with <code>keepAlive</code> enabled, then it is best to explicitly shut down 532the agent when it is no longer needed. Otherwise, 533sockets might stay open for quite a long time before the server 534terminates them.</p> 535<h4><code>agent.freeSockets</code><span><a class="mark" href="#http_agent_freesockets" id="http_agent_freesockets">#</a></span></h4> 536<div class="api_metadata"> 537<span>Added in: v0.11.4</span> 538</div> 539<ul> 540<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 541</ul> 542<p>An object which contains arrays of sockets currently awaiting use by 543the agent when <code>keepAlive</code> is enabled. Do not modify.</p> 544<p>Sockets in the <code>freeSockets</code> list will be automatically destroyed and 545removed from the array on <code>'timeout'</code>.</p> 546<h4><code>agent.getName(options)</code><span><a class="mark" href="#http_agent_getname_options" id="http_agent_getname_options">#</a></span></h4> 547<div class="api_metadata"> 548<span>Added in: v0.11.4</span> 549</div> 550<ul> 551<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> A set of options providing information for name generation 552<ul> 553<li><code>host</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> A domain name or IP address of the server to issue the 554request to</li> 555<li><code>port</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Port of remote server</li> 556<li><code>localAddress</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> Local interface to bind for network connections 557when issuing the request</li> 558<li><code>family</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><integer></a> Must be 4 or 6 if this doesn't equal <code>undefined</code>.</li> 559</ul> 560</li> 561<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 562</ul> 563<p>Get a unique name for a set of request options, to determine whether a 564connection can be reused. For an HTTP agent, this returns 565<code>host:port:localAddress</code> or <code>host:port:localAddress:family</code>. For an HTTPS agent, 566the name includes the CA, cert, ciphers, and other HTTPS/TLS-specific options 567that determine socket reusability.</p> 568<h4><code>agent.maxFreeSockets</code><span><a class="mark" href="#http_agent_maxfreesockets" id="http_agent_maxfreesockets">#</a></span></h4> 569<div class="api_metadata"> 570<span>Added in: v0.11.7</span> 571</div> 572<ul> 573<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 574</ul> 575<p>By default set to 256. For agents with <code>keepAlive</code> enabled, this 576sets the maximum number of sockets that will be left open in the free 577state.</p> 578<h4><code>agent.maxSockets</code><span><a class="mark" href="#http_agent_maxsockets" id="http_agent_maxsockets">#</a></span></h4> 579<div class="api_metadata"> 580<span>Added in: v0.3.6</span> 581</div> 582<ul> 583<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 584</ul> 585<p>By default set to <code>Infinity</code>. Determines how many concurrent sockets the agent 586can have open per origin. Origin is the returned value of <a href="#http_agent_getname_options"><code>agent.getName()</code></a>.</p> 587<h4><code>agent.maxTotalSockets</code><span><a class="mark" href="#http_agent_maxtotalsockets" id="http_agent_maxtotalsockets">#</a></span></h4> 588<div class="api_metadata"> 589<span>Added in: v14.5.0</span> 590</div> 591<ul> 592<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 593</ul> 594<p>By default set to <code>Infinity</code>. Determines how many concurrent sockets the agent 595can have open. Unlike <code>maxSockets</code>, this parameter applies across all origins.</p> 596<h4><code>agent.requests</code><span><a class="mark" href="#http_agent_requests" id="http_agent_requests">#</a></span></h4> 597<div class="api_metadata"> 598<span>Added in: v0.5.9</span> 599</div> 600<ul> 601<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 602</ul> 603<p>An object which contains queues of requests that have not yet been assigned to 604sockets. Do not modify.</p> 605<h4><code>agent.sockets</code><span><a class="mark" href="#http_agent_sockets" id="http_agent_sockets">#</a></span></h4> 606<div class="api_metadata"> 607<span>Added in: v0.3.6</span> 608</div> 609<ul> 610<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 611</ul> 612<p>An object which contains arrays of sockets currently in use by the 613agent. Do not modify.</p> 614</section><section><h3>Class: <code>http.ClientRequest</code><span><a class="mark" href="#http_class_http_clientrequest" id="http_class_http_clientrequest">#</a></span></h3> 615<div class="api_metadata"> 616<span>Added in: v0.1.17</span> 617</div> 618<ul> 619<li>Extends: <a href="stream.html#stream_stream" class="type"><Stream></a></li> 620</ul> 621<p>This object is created internally and returned from <a href="#http_http_request_options_callback"><code>http.request()</code></a>. It 622represents an <em>in-progress</em> request whose header has already been queued. The 623header is still mutable using the <a href="#http_request_setheader_name_value"><code>setHeader(name, value)</code></a>, 624<a href="#http_request_getheader_name"><code>getHeader(name)</code></a>, <a href="#http_request_removeheader_name"><code>removeHeader(name)</code></a> API. The actual header will 625be sent along with the first data chunk or when calling <a href="#http_request_end_data_encoding_callback"><code>request.end()</code></a>.</p> 626<p>To get the response, add a listener for <a href="#http_event_response"><code>'response'</code></a> to the request object. 627<a href="#http_event_response"><code>'response'</code></a> will be emitted from the request object when the response 628headers have been received. The <a href="#http_event_response"><code>'response'</code></a> event is executed with one 629argument which is an instance of <a href="#http_class_http_incomingmessage"><code>http.IncomingMessage</code></a>.</p> 630<p>During the <a href="#http_event_response"><code>'response'</code></a> event, one can add listeners to the 631response object; particularly to listen for the <code>'data'</code> event.</p> 632<p>If no <a href="#http_event_response"><code>'response'</code></a> handler is added, then the response will be 633entirely discarded. However, if a <a href="#http_event_response"><code>'response'</code></a> event handler is added, 634then the data from the response object <strong>must</strong> be consumed, either by 635calling <code>response.read()</code> whenever there is a <code>'readable'</code> event, or 636by adding a <code>'data'</code> handler, or by calling the <code>.resume()</code> method. 637Until the data is consumed, the <code>'end'</code> event will not fire. Also, until 638the data is read it will consume memory that can eventually lead to a 639'process out of memory' error.</p> 640<p>Unlike the <code>request</code> object, if the response closes prematurely, the 641<code>response</code> object does not emit an <code>'error'</code> event but instead emits the 642<code>'aborted'</code> event.</p> 643<p>Node.js does not check whether Content-Length and the length of the 644body which has been transmitted are equal or not.</p> 645<h4>Event: <code>'abort'</code><span><a class="mark" href="#http_event_abort" id="http_event_abort">#</a></span></h4> 646<div class="api_metadata"> 647<span>Added in: v1.4.1</span> 648</div> 649<p>Emitted when the request has been aborted by the client. This event is only 650emitted on the first call to <code>abort()</code>.</p> 651<h4>Event: <code>'connect'</code><span><a class="mark" href="#http_event_connect" id="http_event_connect">#</a></span></h4> 652<div class="api_metadata"> 653<span>Added in: v0.7.0</span> 654</div> 655<ul> 656<li><code>response</code> <a href="http.html#http_class_http_incomingmessage" class="type"><http.IncomingMessage></a></li> 657<li><code>socket</code> <a href="stream.html#stream_class_stream_duplex" class="type"><stream.Duplex></a></li> 658<li><code>head</code> <a href="buffer.html#buffer_class_buffer" class="type"><Buffer></a></li> 659</ul> 660<p>Emitted each time a server responds to a request with a <code>CONNECT</code> method. If 661this event is not being listened for, clients receiving a <code>CONNECT</code> method will 662have their connections closed.</p> 663<p>This event is guaranteed to be passed an instance of the <a href="net.html#net_class_net_socket" class="type"><net.Socket></a> class, 664a subclass of <a href="stream.html#stream_class_stream_duplex" class="type"><stream.Duplex></a>, unless the user specifies a socket 665type other than <a href="net.html#net_class_net_socket" class="type"><net.Socket></a>.</p> 666<p>A client and server pair demonstrating how to listen for the <code>'connect'</code> event:</p> 667<pre><code class="language-js"><span class="hljs-keyword">const</span> http = <span class="hljs-built_in">require</span>(<span class="hljs-string">'http'</span>); 668<span class="hljs-keyword">const</span> net = <span class="hljs-built_in">require</span>(<span class="hljs-string">'net'</span>); 669<span class="hljs-keyword">const</span> { <span class="hljs-variable constant_">URL</span> } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'url'</span>); 670 671<span class="hljs-comment">// Create an HTTP tunneling proxy</span> 672<span class="hljs-keyword">const</span> proxy = http.<span class="hljs-title function_">createServer</span>(<span class="hljs-function">(<span class="hljs-params">req, res</span>) =></span> { 673 res.<span class="hljs-title function_">writeHead</span>(<span class="hljs-number">200</span>, { <span class="hljs-string">'Content-Type'</span>: <span class="hljs-string">'text/plain'</span> }); 674 res.<span class="hljs-title function_">end</span>(<span class="hljs-string">'okay'</span>); 675}); 676proxy.<span class="hljs-title function_">on</span>(<span class="hljs-string">'connect'</span>, <span class="hljs-function">(<span class="hljs-params">req, clientSocket, head</span>) =></span> { 677 <span class="hljs-comment">// Connect to an origin server</span> 678 <span class="hljs-keyword">const</span> { port, hostname } = <span class="hljs-keyword">new</span> <span class="hljs-title function_">URL</span>(<span class="hljs-string">`http://<span class="hljs-subst">${req.url}</span>`</span>); 679 <span class="hljs-keyword">const</span> serverSocket = net.<span class="hljs-title function_">connect</span>(port || <span class="hljs-number">80</span>, hostname, <span class="hljs-function">() =></span> { 680 clientSocket.<span class="hljs-title function_">write</span>(<span class="hljs-string">'HTTP/1.1 200 Connection Established\r\n'</span> + 681 <span class="hljs-string">'Proxy-agent: Node.js-Proxy\r\n'</span> + 682 <span class="hljs-string">'\r\n'</span>); 683 serverSocket.<span class="hljs-title function_">write</span>(head); 684 serverSocket.<span class="hljs-title function_">pipe</span>(clientSocket); 685 clientSocket.<span class="hljs-title function_">pipe</span>(serverSocket); 686 }); 687}); 688 689<span class="hljs-comment">// Now that proxy is running</span> 690proxy.<span class="hljs-title function_">listen</span>(<span class="hljs-number">1337</span>, <span class="hljs-string">'127.0.0.1'</span>, <span class="hljs-function">() =></span> { 691 692 <span class="hljs-comment">// Make a request to a tunneling proxy</span> 693 <span class="hljs-keyword">const</span> options = { 694 <span class="hljs-attr">port</span>: <span class="hljs-number">1337</span>, 695 <span class="hljs-attr">host</span>: <span class="hljs-string">'127.0.0.1'</span>, 696 <span class="hljs-attr">method</span>: <span class="hljs-string">'CONNECT'</span>, 697 <span class="hljs-attr">path</span>: <span class="hljs-string">'www.google.com:80'</span> 698 }; 699 700 <span class="hljs-keyword">const</span> req = http.<span class="hljs-title function_">request</span>(options); 701 req.<span class="hljs-title function_">end</span>(); 702 703 req.<span class="hljs-title function_">on</span>(<span class="hljs-string">'connect'</span>, <span class="hljs-function">(<span class="hljs-params">res, socket, head</span>) =></span> { 704 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">'got connected!'</span>); 705 706 <span class="hljs-comment">// Make a request over an HTTP tunnel</span> 707 socket.<span class="hljs-title function_">write</span>(<span class="hljs-string">'GET / HTTP/1.1\r\n'</span> + 708 <span class="hljs-string">'Host: www.google.com:80\r\n'</span> + 709 <span class="hljs-string">'Connection: close\r\n'</span> + 710 <span class="hljs-string">'\r\n'</span>); 711 socket.<span class="hljs-title function_">on</span>(<span class="hljs-string">'data'</span>, <span class="hljs-function">(<span class="hljs-params">chunk</span>) =></span> { 712 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(chunk.<span class="hljs-title function_">toString</span>()); 713 }); 714 socket.<span class="hljs-title function_">on</span>(<span class="hljs-string">'end'</span>, <span class="hljs-function">() =></span> { 715 proxy.<span class="hljs-title function_">close</span>(); 716 }); 717 }); 718});</code></pre> 719<h4>Event: <code>'continue'</code><span><a class="mark" href="#http_event_continue" id="http_event_continue">#</a></span></h4> 720<div class="api_metadata"> 721<span>Added in: v0.3.2</span> 722</div> 723<p>Emitted when the server sends a '100 Continue' HTTP response, usually because 724the request contained 'Expect: 100-continue'. This is an instruction that 725the client should send the request body.</p> 726<h4>Event: <code>'information'</code><span><a class="mark" href="#http_event_information" id="http_event_information">#</a></span></h4> 727<div class="api_metadata"> 728<span>Added in: v10.0.0</span> 729</div> 730<ul> 731<li><code>info</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 732<ul> 733<li><code>httpVersion</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 734<li><code>httpVersionMajor</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><integer></a></li> 735<li><code>httpVersionMinor</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><integer></a></li> 736<li><code>statusCode</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><integer></a></li> 737<li><code>statusMessage</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 738<li><code>headers</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 739<li><code>rawHeaders</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string[]></a></li> 740</ul> 741</li> 742</ul> 743<p>Emitted when the server sends a 1xx intermediate response (excluding 101 744Upgrade). The listeners of this event will receive an object containing the 745HTTP version, status code, status message, key-value headers object, 746and array with the raw header names followed by their respective values.</p> 747<pre><code class="language-js"><span class="hljs-keyword">const</span> http = <span class="hljs-built_in">require</span>(<span class="hljs-string">'http'</span>); 748 749<span class="hljs-keyword">const</span> options = { 750 <span class="hljs-attr">host</span>: <span class="hljs-string">'127.0.0.1'</span>, 751 <span class="hljs-attr">port</span>: <span class="hljs-number">8080</span>, 752 <span class="hljs-attr">path</span>: <span class="hljs-string">'/length_request'</span> 753}; 754 755<span class="hljs-comment">// Make a request</span> 756<span class="hljs-keyword">const</span> req = http.<span class="hljs-title function_">request</span>(options); 757req.<span class="hljs-title function_">end</span>(); 758 759req.<span class="hljs-title function_">on</span>(<span class="hljs-string">'information'</span>, <span class="hljs-function">(<span class="hljs-params">info</span>) =></span> { 760 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">`Got information prior to main response: <span class="hljs-subst">${info.statusCode}</span>`</span>); 761});</code></pre> 762<p>101 Upgrade statuses do not fire this event due to their break from the 763traditional HTTP request/response chain, such as web sockets, in-place TLS 764upgrades, or HTTP 2.0. To be notified of 101 Upgrade notices, listen for the 765<a href="#http_event_upgrade"><code>'upgrade'</code></a> event instead.</p> 766<h4>Event: <code>'response'</code><span><a class="mark" href="#http_event_response" id="http_event_response">#</a></span></h4> 767<div class="api_metadata"> 768<span>Added in: v0.1.0</span> 769</div> 770<ul> 771<li><code>response</code> <a href="http.html#http_class_http_incomingmessage" class="type"><http.IncomingMessage></a></li> 772</ul> 773<p>Emitted when a response is received to this request. This event is emitted only 774once.</p> 775<h4>Event: <code>'socket'</code><span><a class="mark" href="#http_event_socket" id="http_event_socket">#</a></span></h4> 776<div class="api_metadata"> 777<span>Added in: v0.5.3</span> 778</div> 779<ul> 780<li><code>socket</code> <a href="stream.html#stream_class_stream_duplex" class="type"><stream.Duplex></a></li> 781</ul> 782<p>This event is guaranteed to be passed an instance of the <a href="net.html#net_class_net_socket" class="type"><net.Socket></a> class, 783a subclass of <a href="stream.html#stream_class_stream_duplex" class="type"><stream.Duplex></a>, unless the user specifies a socket 784type other than <a href="net.html#net_class_net_socket" class="type"><net.Socket></a>.</p> 785<h4>Event: <code>'timeout'</code><span><a class="mark" href="#http_event_timeout" id="http_event_timeout">#</a></span></h4> 786<div class="api_metadata"> 787<span>Added in: v0.7.8</span> 788</div> 789<p>Emitted when the underlying socket times out from inactivity. This only notifies 790that the socket has been idle. The request must be aborted manually.</p> 791<p>See also: <a href="#http_request_settimeout_timeout_callback"><code>request.setTimeout()</code></a>.</p> 792<h4>Event: <code>'upgrade'</code><span><a class="mark" href="#http_event_upgrade" id="http_event_upgrade">#</a></span></h4> 793<div class="api_metadata"> 794<span>Added in: v0.1.94</span> 795</div> 796<ul> 797<li><code>response</code> <a href="http.html#http_class_http_incomingmessage" class="type"><http.IncomingMessage></a></li> 798<li><code>socket</code> <a href="stream.html#stream_class_stream_duplex" class="type"><stream.Duplex></a></li> 799<li><code>head</code> <a href="buffer.html#buffer_class_buffer" class="type"><Buffer></a></li> 800</ul> 801<p>Emitted each time a server responds to a request with an upgrade. If this 802event is not being listened for and the response status code is 101 Switching 803Protocols, clients receiving an upgrade header will have their connections 804closed.</p> 805<p>This event is guaranteed to be passed an instance of the <a href="net.html#net_class_net_socket" class="type"><net.Socket></a> class, 806a subclass of <a href="stream.html#stream_class_stream_duplex" class="type"><stream.Duplex></a>, unless the user specifies a socket 807type other than <a href="net.html#net_class_net_socket" class="type"><net.Socket></a>.</p> 808<p>A client server pair demonstrating how to listen for the <code>'upgrade'</code> event.</p> 809<pre><code class="language-js"><span class="hljs-keyword">const</span> http = <span class="hljs-built_in">require</span>(<span class="hljs-string">'http'</span>); 810 811<span class="hljs-comment">// Create an HTTP server</span> 812<span class="hljs-keyword">const</span> server = http.<span class="hljs-title function_">createServer</span>(<span class="hljs-function">(<span class="hljs-params">req, res</span>) =></span> { 813 res.<span class="hljs-title function_">writeHead</span>(<span class="hljs-number">200</span>, { <span class="hljs-string">'Content-Type'</span>: <span class="hljs-string">'text/plain'</span> }); 814 res.<span class="hljs-title function_">end</span>(<span class="hljs-string">'okay'</span>); 815}); 816server.<span class="hljs-title function_">on</span>(<span class="hljs-string">'upgrade'</span>, <span class="hljs-function">(<span class="hljs-params">req, socket, head</span>) =></span> { 817 socket.<span class="hljs-title function_">write</span>(<span class="hljs-string">'HTTP/1.1 101 Web Socket Protocol Handshake\r\n'</span> + 818 <span class="hljs-string">'Upgrade: WebSocket\r\n'</span> + 819 <span class="hljs-string">'Connection: Upgrade\r\n'</span> + 820 <span class="hljs-string">'\r\n'</span>); 821 822 socket.<span class="hljs-title function_">pipe</span>(socket); <span class="hljs-comment">// echo back</span> 823}); 824 825<span class="hljs-comment">// Now that server is running</span> 826server.<span class="hljs-title function_">listen</span>(<span class="hljs-number">1337</span>, <span class="hljs-string">'127.0.0.1'</span>, <span class="hljs-function">() =></span> { 827 828 <span class="hljs-comment">// make a request</span> 829 <span class="hljs-keyword">const</span> options = { 830 <span class="hljs-attr">port</span>: <span class="hljs-number">1337</span>, 831 <span class="hljs-attr">host</span>: <span class="hljs-string">'127.0.0.1'</span>, 832 <span class="hljs-attr">headers</span>: { 833 <span class="hljs-string">'Connection'</span>: <span class="hljs-string">'Upgrade'</span>, 834 <span class="hljs-string">'Upgrade'</span>: <span class="hljs-string">'websocket'</span> 835 } 836 }; 837 838 <span class="hljs-keyword">const</span> req = http.<span class="hljs-title function_">request</span>(options); 839 req.<span class="hljs-title function_">end</span>(); 840 841 req.<span class="hljs-title function_">on</span>(<span class="hljs-string">'upgrade'</span>, <span class="hljs-function">(<span class="hljs-params">res, socket, upgradeHead</span>) =></span> { 842 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">'got upgraded!'</span>); 843 socket.<span class="hljs-title function_">end</span>(); 844 process.<span class="hljs-title function_">exit</span>(<span class="hljs-number">0</span>); 845 }); 846});</code></pre> 847<h4><code>request.abort()</code><span><a class="mark" href="#http_request_abort" id="http_request_abort">#</a></span></h4> 848<div class="api_metadata"> 849<span>Added in: v0.3.8</span><span>Deprecated since: v14.1.0</span> 850</div> 851<p></p><div class="api_stability api_stability_0"><a href="documentation.html#documentation_stability_index">Stability: 0</a> - Deprecated: Use <a href="#http_request_destroy_error"><code>request.destroy()</code></a> instead.</div><p></p> 852<p>Marks the request as aborting. Calling this will cause remaining data 853in the response to be dropped and the socket to be destroyed.</p> 854<h4><code>request.aborted</code><span><a class="mark" href="#http_request_aborted" id="http_request_aborted">#</a></span></h4> 855<div class="api_metadata"> 856<details class="changelog"><summary>History</summary> 857<table> 858<tbody><tr><th>Version</th><th>Changes</th></tr> 859<tr><td>v11.0.0</td> 860<td><p>The <code>aborted</code> property is no longer a timestamp number.</p></td></tr> 861<tr><td>v0.11.14</td> 862<td><p><span>Added in: v0.11.14</span></p></td></tr> 863</tbody></table> 864</details> 865</div> 866<ul> 867<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 868</ul> 869<p>The <code>request.aborted</code> property will be <code>true</code> if the request has 870been aborted.</p> 871<h4><code>request.connection</code><span><a class="mark" href="#http_request_connection" id="http_request_connection">#</a></span></h4> 872<div class="api_metadata"> 873<span>Added in: v0.3.0</span><span>Deprecated since: v13.0.0</span> 874</div> 875<p></p><div class="api_stability api_stability_0"><a href="documentation.html#documentation_stability_index">Stability: 0</a> - Deprecated. Use <a href="#http_request_socket"><code>request.socket</code></a>.</div><p></p> 876<ul> 877<li><a href="stream.html#stream_class_stream_duplex" class="type"><stream.Duplex></a></li> 878</ul> 879<p>See <a href="#http_request_socket"><code>request.socket</code></a>.</p> 880<h4><code>request.end([data[, encoding]][, callback])</code><span><a class="mark" href="#http_request_end_data_encoding_callback" id="http_request_end_data_encoding_callback">#</a></span></h4> 881<div class="api_metadata"> 882<details class="changelog"><summary>History</summary> 883<table> 884<tbody><tr><th>Version</th><th>Changes</th></tr> 885<tr><td>v10.0.0</td> 886<td><p>This method now returns a reference to <code>ClientRequest</code>.</p></td></tr> 887<tr><td>v0.1.90</td> 888<td><p><span>Added in: v0.1.90</span></p></td></tr> 889</tbody></table> 890</details> 891</div> 892<ul> 893<li><code>data</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> | <a href="buffer.html#buffer_class_buffer" class="type"><Buffer></a></li> 894<li><code>encoding</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 895<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 896<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/this" class="type"><this></a></li> 897</ul> 898<p>Finishes sending the request. If any parts of the body are 899unsent, it will flush them to the stream. If the request is 900chunked, this will send the terminating <code>'0\r\n\r\n'</code>.</p> 901<p>If <code>data</code> is specified, it is equivalent to calling 902<a href="#http_request_write_chunk_encoding_callback"><code>request.write(data, encoding)</code></a> followed by <code>request.end(callback)</code>.</p> 903<p>If <code>callback</code> is specified, it will be called when the request stream 904is finished.</p> 905<h4><code>request.destroy([error])</code><span><a class="mark" href="#http_request_destroy_error" id="http_request_destroy_error">#</a></span></h4> 906<div class="api_metadata"> 907<details class="changelog"><summary>History</summary> 908<table> 909<tbody><tr><th>Version</th><th>Changes</th></tr> 910<tr><td>v14.5.0</td> 911<td><p>The function returns <code>this</code> for consistency with other Readable streams.</p></td></tr> 912<tr><td>v0.3.0</td> 913<td><p><span>Added in: v0.3.0</span></p></td></tr> 914</tbody></table> 915</details> 916</div> 917<ul> 918<li><code>error</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" class="type"><Error></a> Optional, an error to emit with <code>'error'</code> event.</li> 919<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/this" class="type"><this></a></li> 920</ul> 921<p>Destroy the request. Optionally emit an <code>'error'</code> event, 922and emit a <code>'close'</code> event. Calling this will cause remaining data 923in the response to be dropped and the socket to be destroyed.</p> 924<p>See <a href="stream.html#stream_writable_destroy_error"><code>writable.destroy()</code></a> for further details.</p> 925<h5><code>request.destroyed</code><span><a class="mark" href="#http_request_destroyed" id="http_request_destroyed">#</a></span></h5> 926<div class="api_metadata"> 927<span>Added in: v14.1.0</span> 928</div> 929<ul> 930<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 931</ul> 932<p>Is <code>true</code> after <a href="#http_request_destroy_error"><code>request.destroy()</code></a> has been called.</p> 933<p>See <a href="stream.html#stream_writable_destroyed"><code>writable.destroyed</code></a> for further details.</p> 934<h4><code>request.finished</code><span><a class="mark" href="#http_request_finished" id="http_request_finished">#</a></span></h4> 935<div class="api_metadata"> 936<span>Added in: v0.0.1</span><span>Deprecated since: v13.4.0, v12.16.0</span> 937</div> 938<p></p><div class="api_stability api_stability_0"><a href="documentation.html#documentation_stability_index">Stability: 0</a> - Deprecated. Use <a href="#http_request_writableended"><code>request.writableEnded</code></a>.</div><p></p> 939<ul> 940<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 941</ul> 942<p>The <code>request.finished</code> property will be <code>true</code> if <a href="#http_request_end_data_encoding_callback"><code>request.end()</code></a> 943has been called. <code>request.end()</code> will automatically be called if the 944request was initiated via <a href="#http_http_get_options_callback"><code>http.get()</code></a>.</p> 945<h4><code>request.flushHeaders()</code><span><a class="mark" href="#http_request_flushheaders" id="http_request_flushheaders">#</a></span></h4> 946<div class="api_metadata"> 947<span>Added in: v1.6.0</span> 948</div> 949<p>Flushes the request headers.</p> 950<p>For efficiency reasons, Node.js normally buffers the request headers until 951<code>request.end()</code> is called or the first chunk of request data is written. It 952then tries to pack the request headers and data into a single TCP packet.</p> 953<p>That's usually desired (it saves a TCP round-trip), but not when the first 954data is not sent until possibly much later. <code>request.flushHeaders()</code> bypasses 955the optimization and kickstarts the request.</p> 956<h4><code>request.getHeader(name)</code><span><a class="mark" href="#http_request_getheader_name" id="http_request_getheader_name">#</a></span></h4> 957<div class="api_metadata"> 958<span>Added in: v1.6.0</span> 959</div> 960<ul> 961<li><code>name</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 962<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 963</ul> 964<p>Reads out a header on the request. The name is case-insensitive. 965The type of the return value depends on the arguments provided to 966<a href="#http_request_setheader_name_value"><code>request.setHeader()</code></a>.</p> 967<pre><code class="language-js">request.<span class="hljs-title function_">setHeader</span>(<span class="hljs-string">'content-type'</span>, <span class="hljs-string">'text/html'</span>); 968request.<span class="hljs-title function_">setHeader</span>(<span class="hljs-string">'Content-Length'</span>, <span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">byteLength</span>(body)); 969request.<span class="hljs-title function_">setHeader</span>(<span class="hljs-string">'Cookie'</span>, [<span class="hljs-string">'type=ninja'</span>, <span class="hljs-string">'language=javascript'</span>]); 970<span class="hljs-keyword">const</span> contentType = request.<span class="hljs-title function_">getHeader</span>(<span class="hljs-string">'Content-Type'</span>); 971<span class="hljs-comment">// 'contentType' is 'text/html'</span> 972<span class="hljs-keyword">const</span> contentLength = request.<span class="hljs-title function_">getHeader</span>(<span class="hljs-string">'Content-Length'</span>); 973<span class="hljs-comment">// 'contentLength' is of type number</span> 974<span class="hljs-keyword">const</span> cookie = request.<span class="hljs-title function_">getHeader</span>(<span class="hljs-string">'Cookie'</span>); 975<span class="hljs-comment">// 'cookie' is of type string[]</span></code></pre> 976<h4><code>request.getRawHeaderNames()</code><span><a class="mark" href="#http_request_getrawheadernames" id="http_request_getrawheadernames">#</a></span></h4> 977<div class="api_metadata"> 978<span>Added in: v14.17.0</span> 979</div> 980<ul> 981<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string[]></a></li> 982</ul> 983<p>Returns an array containing the unique names of the current outgoing raw 984headers. Header names are returned with their exact casing being set.</p> 985<pre><code class="language-js">request.<span class="hljs-title function_">setHeader</span>(<span class="hljs-string">'Foo'</span>, <span class="hljs-string">'bar'</span>); 986request.<span class="hljs-title function_">setHeader</span>(<span class="hljs-string">'Set-Cookie'</span>, [<span class="hljs-string">'foo=bar'</span>, <span class="hljs-string">'bar=baz'</span>]); 987 988<span class="hljs-keyword">const</span> headerNames = request.<span class="hljs-title function_">getRawHeaderNames</span>(); 989<span class="hljs-comment">// headerNames === ['Foo', 'Set-Cookie']</span></code></pre> 990<h4><code>request.maxHeadersCount</code><span><a class="mark" href="#http_request_maxheaderscount" id="http_request_maxheaderscount">#</a></span></h4> 991<ul> 992<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> <strong>Default:</strong> <code>2000</code></li> 993</ul> 994<p>Limits maximum response headers count. If set to 0, no limit will be applied.</p> 995<h4><code>request.path</code><span><a class="mark" href="#http_request_path" id="http_request_path">#</a></span></h4> 996<div class="api_metadata"> 997<span>Added in: v0.4.0</span> 998</div> 999<ul> 1000<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> The request path.</li> 1001</ul> 1002<h4><code>request.method</code><span><a class="mark" href="#http_request_method" id="http_request_method">#</a></span></h4> 1003<div class="api_metadata"> 1004<span>Added in: v0.1.97</span> 1005</div> 1006<ul> 1007<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> The request method.</li> 1008</ul> 1009<h4><code>request.host</code><span><a class="mark" href="#http_request_host" id="http_request_host">#</a></span></h4> 1010<div class="api_metadata"> 1011<span>Added in: v14.5.0</span> 1012</div> 1013<ul> 1014<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> The request host.</li> 1015</ul> 1016<h4><code>request.protocol</code><span><a class="mark" href="#http_request_protocol" id="http_request_protocol">#</a></span></h4> 1017<div class="api_metadata"> 1018<span>Added in: v14.5.0</span> 1019</div> 1020<ul> 1021<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> The request protocol.</li> 1022</ul> 1023<h4><code>request.removeHeader(name)</code><span><a class="mark" href="#http_request_removeheader_name" id="http_request_removeheader_name">#</a></span></h4> 1024<div class="api_metadata"> 1025<span>Added in: v1.6.0</span> 1026</div> 1027<ul> 1028<li><code>name</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 1029</ul> 1030<p>Removes a header that's already defined into headers object.</p> 1031<pre><code class="language-js">request.<span class="hljs-title function_">removeHeader</span>(<span class="hljs-string">'Content-Type'</span>);</code></pre> 1032<h4><code>request.reusedSocket</code><span><a class="mark" href="#http_request_reusedsocket" id="http_request_reusedsocket">#</a></span></h4> 1033<div class="api_metadata"> 1034<span>Added in: v13.0.0, v12.16.0</span> 1035</div> 1036<ul> 1037<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> Whether the request is send through a reused socket.</li> 1038</ul> 1039<p>When sending request through a keep-alive enabled agent, the underlying socket 1040might be reused. But if server closes connection at unfortunate time, client 1041may run into a 'ECONNRESET' error.</p> 1042<pre><code class="language-js"><span class="hljs-keyword">const</span> http = <span class="hljs-built_in">require</span>(<span class="hljs-string">'http'</span>); 1043 1044<span class="hljs-comment">// Server has a 5 seconds keep-alive timeout by default</span> 1045http 1046 .<span class="hljs-title function_">createServer</span>(<span class="hljs-function">(<span class="hljs-params">req, res</span>) =></span> { 1047 res.<span class="hljs-title function_">write</span>(<span class="hljs-string">'hello\n'</span>); 1048 res.<span class="hljs-title function_">end</span>(); 1049 }) 1050 .<span class="hljs-title function_">listen</span>(<span class="hljs-number">3000</span>); 1051 1052<span class="hljs-built_in">setInterval</span>(<span class="hljs-function">() =></span> { 1053 <span class="hljs-comment">// Adapting a keep-alive agent</span> 1054 http.<span class="hljs-title function_">get</span>(<span class="hljs-string">'http://localhost:3000'</span>, { agent }, <span class="hljs-function">(<span class="hljs-params">res</span>) =></span> { 1055 res.<span class="hljs-title function_">on</span>(<span class="hljs-string">'data'</span>, <span class="hljs-function">(<span class="hljs-params">data</span>) =></span> { 1056 <span class="hljs-comment">// Do nothing</span> 1057 }); 1058 }); 1059}, <span class="hljs-number">5000</span>); <span class="hljs-comment">// Sending request on 5s interval so it's easy to hit idle timeout</span></code></pre> 1060<p>By marking a request whether it reused socket or not, we can do 1061automatic error retry base on it.</p> 1062<pre><code class="language-js"><span class="hljs-keyword">const</span> http = <span class="hljs-built_in">require</span>(<span class="hljs-string">'http'</span>); 1063<span class="hljs-keyword">const</span> agent = <span class="hljs-keyword">new</span> http.<span class="hljs-title class_">Agent</span>({ <span class="hljs-attr">keepAlive</span>: <span class="hljs-literal">true</span> }); 1064 1065<span class="hljs-keyword">function</span> <span class="hljs-title function_">retriableRequest</span>(<span class="hljs-params"></span>) { 1066 <span class="hljs-keyword">const</span> req = http 1067 .<span class="hljs-title function_">get</span>(<span class="hljs-string">'http://localhost:3000'</span>, { agent }, <span class="hljs-function">(<span class="hljs-params">res</span>) =></span> { 1068 <span class="hljs-comment">// ...</span> 1069 }) 1070 .<span class="hljs-title function_">on</span>(<span class="hljs-string">'error'</span>, <span class="hljs-function">(<span class="hljs-params">err</span>) =></span> { 1071 <span class="hljs-comment">// Check if retry is needed</span> 1072 <span class="hljs-keyword">if</span> (req.<span class="hljs-property">reusedSocket</span> && err.<span class="hljs-property">code</span> === <span class="hljs-string">'ECONNRESET'</span>) { 1073 <span class="hljs-title function_">retriableRequest</span>(); 1074 } 1075 }); 1076} 1077 1078<span class="hljs-title function_">retriableRequest</span>();</code></pre> 1079<h4><code>request.setHeader(name, value)</code><span><a class="mark" href="#http_request_setheader_name_value" id="http_request_setheader_name_value">#</a></span></h4> 1080<div class="api_metadata"> 1081<span>Added in: v1.6.0</span> 1082</div> 1083<ul> 1084<li><code>name</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 1085<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1086</ul> 1087<p>Sets a single header value for headers object. If this header already exists in 1088the to-be-sent headers, its value will be replaced. Use an array of strings 1089here to send multiple headers with the same name. Non-string values will be 1090stored without modification. Therefore, <a href="#http_request_getheader_name"><code>request.getHeader()</code></a> may return 1091non-string values. However, the non-string values will be converted to strings 1092for network transmission.</p> 1093<pre><code class="language-js">request.<span class="hljs-title function_">setHeader</span>(<span class="hljs-string">'Content-Type'</span>, <span class="hljs-string">'application/json'</span>);</code></pre> 1094<p>or</p> 1095<pre><code class="language-js">request.<span class="hljs-title function_">setHeader</span>(<span class="hljs-string">'Cookie'</span>, [<span class="hljs-string">'type=ninja'</span>, <span class="hljs-string">'language=javascript'</span>]);</code></pre> 1096<h4><code>request.setNoDelay([noDelay])</code><span><a class="mark" href="#http_request_setnodelay_nodelay" id="http_request_setnodelay_nodelay">#</a></span></h4> 1097<div class="api_metadata"> 1098<span>Added in: v0.5.9</span> 1099</div> 1100<ul> 1101<li><code>noDelay</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1102</ul> 1103<p>Once a socket is assigned to this request and is connected 1104<a href="net.html#net_socket_setnodelay_nodelay"><code>socket.setNoDelay()</code></a> will be called.</p> 1105<h4><code>request.setSocketKeepAlive([enable][, initialDelay])</code><span><a class="mark" href="#http_request_setsocketkeepalive_enable_initialdelay" id="http_request_setsocketkeepalive_enable_initialdelay">#</a></span></h4> 1106<div class="api_metadata"> 1107<span>Added in: v0.5.9</span> 1108</div> 1109<ul> 1110<li><code>enable</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1111<li><code>initialDelay</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 1112</ul> 1113<p>Once a socket is assigned to this request and is connected 1114<a href="net.html#net_socket_setkeepalive_enable_initialdelay"><code>socket.setKeepAlive()</code></a> will be called.</p> 1115<h4><code>request.setTimeout(timeout[, callback])</code><span><a class="mark" href="#http_request_settimeout_timeout_callback" id="http_request_settimeout_timeout_callback">#</a></span></h4> 1116<div class="api_metadata"> 1117<details class="changelog"><summary>History</summary> 1118<table> 1119<tbody><tr><th>Version</th><th>Changes</th></tr> 1120<tr><td>v9.0.0</td> 1121<td><p>Consistently set socket timeout only when the socket connects.</p></td></tr> 1122<tr><td>v0.5.9</td> 1123<td><p><span>Added in: v0.5.9</span></p></td></tr> 1124</tbody></table> 1125</details> 1126</div> 1127<ul> 1128<li><code>timeout</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Milliseconds before a request times out.</li> 1129<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> Optional function to be called when a timeout occurs. 1130Same as binding to the <code>'timeout'</code> event.</li> 1131<li>Returns: <a href="http.html#http_class_http_clientrequest" class="type"><http.ClientRequest></a></li> 1132</ul> 1133<p>Once a socket is assigned to this request and is connected 1134<a href="net.html#net_socket_settimeout_timeout_callback"><code>socket.setTimeout()</code></a> will be called.</p> 1135<h4><code>request.socket</code><span><a class="mark" href="#http_request_socket" id="http_request_socket">#</a></span></h4> 1136<div class="api_metadata"> 1137<span>Added in: v0.3.0</span> 1138</div> 1139<ul> 1140<li><a href="stream.html#stream_class_stream_duplex" class="type"><stream.Duplex></a></li> 1141</ul> 1142<p>Reference to the underlying socket. Usually users will not want to access 1143this property. In particular, the socket will not emit <code>'readable'</code> events 1144because of how the protocol parser attaches to the socket.</p> 1145<pre><code class="language-js"><span class="hljs-keyword">const</span> http = <span class="hljs-built_in">require</span>(<span class="hljs-string">'http'</span>); 1146<span class="hljs-keyword">const</span> options = { 1147 <span class="hljs-attr">host</span>: <span class="hljs-string">'www.google.com'</span>, 1148}; 1149<span class="hljs-keyword">const</span> req = http.<span class="hljs-title function_">get</span>(options); 1150req.<span class="hljs-title function_">end</span>(); 1151req.<span class="hljs-title function_">once</span>(<span class="hljs-string">'response'</span>, <span class="hljs-function">(<span class="hljs-params">res</span>) =></span> { 1152 <span class="hljs-keyword">const</span> ip = req.<span class="hljs-property">socket</span>.<span class="hljs-property">localAddress</span>; 1153 <span class="hljs-keyword">const</span> port = req.<span class="hljs-property">socket</span>.<span class="hljs-property">localPort</span>; 1154 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">`Your IP address is <span class="hljs-subst">${ip}</span> and your source port is <span class="hljs-subst">${port}</span>.`</span>); 1155 <span class="hljs-comment">// Consume response object</span> 1156});</code></pre> 1157<p>This property is guaranteed to be an instance of the <a href="net.html#net_class_net_socket" class="type"><net.Socket></a> class, 1158a subclass of <a href="stream.html#stream_class_stream_duplex" class="type"><stream.Duplex></a>, unless the user specified a socket 1159type other than <a href="net.html#net_class_net_socket" class="type"><net.Socket></a>.</p> 1160<h4><code>request.writableEnded</code><span><a class="mark" href="#http_request_writableended" id="http_request_writableended">#</a></span></h4> 1161<div class="api_metadata"> 1162<span>Added in: v12.9.0</span> 1163</div> 1164<ul> 1165<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1166</ul> 1167<p>Is <code>true</code> after <a href="#http_request_end_data_encoding_callback"><code>request.end()</code></a> has been called. This property 1168does not indicate whether the data has been flushed, for this use 1169<a href="#http_request_writablefinished"><code>request.writableFinished</code></a> instead.</p> 1170<h4><code>request.writableFinished</code><span><a class="mark" href="#http_request_writablefinished" id="http_request_writablefinished">#</a></span></h4> 1171<div class="api_metadata"> 1172<span>Added in: v12.7.0</span> 1173</div> 1174<ul> 1175<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1176</ul> 1177<p>Is <code>true</code> if all data has been flushed to the underlying system, immediately 1178before the <a href="#http_event_finish"><code>'finish'</code></a> event is emitted.</p> 1179<h4><code>request.write(chunk[, encoding][, callback])</code><span><a class="mark" href="#http_request_write_chunk_encoding_callback" id="http_request_write_chunk_encoding_callback">#</a></span></h4> 1180<div class="api_metadata"> 1181<span>Added in: v0.1.29</span> 1182</div> 1183<ul> 1184<li><code>chunk</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> | <a href="buffer.html#buffer_class_buffer" class="type"><Buffer></a></li> 1185<li><code>encoding</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 1186<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 1187<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1188</ul> 1189<p>Sends a chunk of the body. This method can be called multiple times. If no 1190<code>Content-Length</code> is set, data will automatically be encoded in HTTP Chunked 1191transfer encoding, so that server knows when the data ends. The 1192<code>Transfer-Encoding: chunked</code> header is added. Calling <a href="#http_request_end_data_encoding_callback"><code>request.end()</code></a> 1193is necessary to finish sending the request.</p> 1194<p>The <code>encoding</code> argument is optional and only applies when <code>chunk</code> is a string. 1195Defaults to <code>'utf8'</code>.</p> 1196<p>The <code>callback</code> argument is optional and will be called when this chunk of data 1197is flushed, but only if the chunk is non-empty.</p> 1198<p>Returns <code>true</code> if the entire data was flushed successfully to the kernel 1199buffer. Returns <code>false</code> if all or part of the data was queued in user memory. 1200<code>'drain'</code> will be emitted when the buffer is free again.</p> 1201<p>When <code>write</code> function is called with empty string or buffer, it does 1202nothing and waits for more input.</p> 1203</section><section><h3>Class: <code>http.Server</code><span><a class="mark" href="#http_class_http_server" id="http_class_http_server">#</a></span></h3> 1204<div class="api_metadata"> 1205<span>Added in: v0.1.17</span> 1206</div> 1207<ul> 1208<li>Extends: <a href="net.html#net_class_net_server" class="type"><net.Server></a></li> 1209</ul> 1210<h4>Event: <code>'checkContinue'</code><span><a class="mark" href="#http_event_checkcontinue" id="http_event_checkcontinue">#</a></span></h4> 1211<div class="api_metadata"> 1212<span>Added in: v0.3.0</span> 1213</div> 1214<ul> 1215<li><code>request</code> <a href="http.html#http_class_http_incomingmessage" class="type"><http.IncomingMessage></a></li> 1216<li><code>response</code> <a href="http.html#http_class_http_serverresponse" class="type"><http.ServerResponse></a></li> 1217</ul> 1218<p>Emitted each time a request with an HTTP <code>Expect: 100-continue</code> is received. 1219If this event is not listened for, the server will automatically respond 1220with a <code>100 Continue</code> as appropriate.</p> 1221<p>Handling this event involves calling <a href="#http_response_writecontinue"><code>response.writeContinue()</code></a> if the 1222client should continue to send the request body, or generating an appropriate 1223HTTP response (e.g. 400 Bad Request) if the client should not continue to send 1224the request body.</p> 1225<p>When this event is emitted and handled, the <a href="#http_event_request"><code>'request'</code></a> event will 1226not be emitted.</p> 1227<h4>Event: <code>'checkExpectation'</code><span><a class="mark" href="#http_event_checkexpectation" id="http_event_checkexpectation">#</a></span></h4> 1228<div class="api_metadata"> 1229<span>Added in: v5.5.0</span> 1230</div> 1231<ul> 1232<li><code>request</code> <a href="http.html#http_class_http_incomingmessage" class="type"><http.IncomingMessage></a></li> 1233<li><code>response</code> <a href="http.html#http_class_http_serverresponse" class="type"><http.ServerResponse></a></li> 1234</ul> 1235<p>Emitted each time a request with an HTTP <code>Expect</code> header is received, where the 1236value is not <code>100-continue</code>. If this event is not listened for, the server will 1237automatically respond with a <code>417 Expectation Failed</code> as appropriate.</p> 1238<p>When this event is emitted and handled, the <a href="#http_event_request"><code>'request'</code></a> event will 1239not be emitted.</p> 1240<h4>Event: <code>'clientError'</code><span><a class="mark" href="#http_event_clienterror" id="http_event_clienterror">#</a></span></h4> 1241<div class="api_metadata"> 1242<details class="changelog"><summary>History</summary> 1243<table> 1244<tbody><tr><th>Version</th><th>Changes</th></tr> 1245<tr><td>v12.0.0</td> 1246<td><p>The default behavior will return a 431 Request Header Fields Too Large if a HPE_HEADER_OVERFLOW error occurs.</p></td></tr> 1247<tr><td>v9.4.0</td> 1248<td><p>The <code>rawPacket</code> is the current buffer that just parsed. Adding this buffer to the error object of <code>'clientError'</code> event is to make it possible that developers can log the broken packet.</p></td></tr> 1249<tr><td>v6.0.0</td> 1250<td><p>The default action of calling <code>.destroy()</code> on the <code>socket</code> will no longer take place if there are listeners attached for <code>'clientError'</code>.</p></td></tr> 1251<tr><td>v0.1.94</td> 1252<td><p><span>Added in: v0.1.94</span></p></td></tr> 1253</tbody></table> 1254</details> 1255</div> 1256<ul> 1257<li><code>exception</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" class="type"><Error></a></li> 1258<li><code>socket</code> <a href="stream.html#stream_class_stream_duplex" class="type"><stream.Duplex></a></li> 1259</ul> 1260<p>If a client connection emits an <code>'error'</code> event, it will be forwarded here. 1261Listener of this event is responsible for closing/destroying the underlying 1262socket. For example, one may wish to more gracefully close the socket with a 1263custom HTTP response instead of abruptly severing the connection.</p> 1264<p>This event is guaranteed to be passed an instance of the <a href="net.html#net_class_net_socket" class="type"><net.Socket></a> class, 1265a subclass of <a href="stream.html#stream_class_stream_duplex" class="type"><stream.Duplex></a>, unless the user specifies a socket 1266type other than <a href="net.html#net_class_net_socket" class="type"><net.Socket></a>.</p> 1267<p>Default behavior is to try close the socket with a HTTP '400 Bad Request', 1268or a HTTP '431 Request Header Fields Too Large' in the case of a 1269<a href="errors.html#errors_hpe_header_overflow"><code>HPE_HEADER_OVERFLOW</code></a> error. If the socket is not writable or has already 1270written data it is immediately destroyed.</p> 1271<p><code>socket</code> is the <a href="net.html#net_class_net_socket"><code>net.Socket</code></a> object that the error originated from.</p> 1272<pre><code class="language-js"><span class="hljs-keyword">const</span> http = <span class="hljs-built_in">require</span>(<span class="hljs-string">'http'</span>); 1273 1274<span class="hljs-keyword">const</span> server = http.<span class="hljs-title function_">createServer</span>(<span class="hljs-function">(<span class="hljs-params">req, res</span>) =></span> { 1275 res.<span class="hljs-title function_">end</span>(); 1276}); 1277server.<span class="hljs-title function_">on</span>(<span class="hljs-string">'clientError'</span>, <span class="hljs-function">(<span class="hljs-params">err, socket</span>) =></span> { 1278 socket.<span class="hljs-title function_">end</span>(<span class="hljs-string">'HTTP/1.1 400 Bad Request\r\n\r\n'</span>); 1279}); 1280server.<span class="hljs-title function_">listen</span>(<span class="hljs-number">8000</span>);</code></pre> 1281<p>When the <code>'clientError'</code> event occurs, there is no <code>request</code> or <code>response</code> 1282object, so any HTTP response sent, including response headers and payload, 1283<em>must</em> be written directly to the <code>socket</code> object. Care must be taken to 1284ensure the response is a properly formatted HTTP response message.</p> 1285<p><code>err</code> is an instance of <code>Error</code> with two extra columns:</p> 1286<ul> 1287<li><code>bytesParsed</code>: the bytes count of request packet that Node.js may have parsed 1288correctly;</li> 1289<li><code>rawPacket</code>: the raw packet of current request.</li> 1290</ul> 1291<p>In some cases, the client has already received the response and/or the socket 1292has already been destroyed, like in case of <code>ECONNRESET</code> errors. Before 1293trying to send data to the socket, it is better to check that it is still 1294writable.</p> 1295<pre><code class="language-js">server.<span class="hljs-title function_">on</span>(<span class="hljs-string">'clientError'</span>, <span class="hljs-function">(<span class="hljs-params">err, socket</span>) =></span> { 1296 <span class="hljs-keyword">if</span> (err.<span class="hljs-property">code</span> === <span class="hljs-string">'ECONNRESET'</span> || !socket.<span class="hljs-property">writable</span>) { 1297 <span class="hljs-keyword">return</span>; 1298 } 1299 1300 socket.<span class="hljs-title function_">end</span>(<span class="hljs-string">'HTTP/1.1 400 Bad Request\r\n\r\n'</span>); 1301});</code></pre> 1302<h4>Event: <code>'close'</code><span><a class="mark" href="#http_event_close" id="http_event_close">#</a></span></h4> 1303<div class="api_metadata"> 1304<span>Added in: v0.1.4</span> 1305</div> 1306<p>Emitted when the server closes.</p> 1307<h4>Event: <code>'connect'</code><span><a class="mark" href="#http_event_connect_1" id="http_event_connect_1">#</a></span></h4> 1308<div class="api_metadata"> 1309<span>Added in: v0.7.0</span> 1310</div> 1311<ul> 1312<li><code>request</code> <a href="http.html#http_class_http_incomingmessage" class="type"><http.IncomingMessage></a> Arguments for the HTTP request, as it is in 1313the <a href="#http_event_request"><code>'request'</code></a> event</li> 1314<li><code>socket</code> <a href="stream.html#stream_class_stream_duplex" class="type"><stream.Duplex></a> Network socket between the server and client</li> 1315<li><code>head</code> <a href="buffer.html#buffer_class_buffer" class="type"><Buffer></a> The first packet of the tunneling stream (may be empty)</li> 1316</ul> 1317<p>Emitted each time a client requests an HTTP <code>CONNECT</code> method. If this event is 1318not listened for, then clients requesting a <code>CONNECT</code> method will have their 1319connections closed.</p> 1320<p>This event is guaranteed to be passed an instance of the <a href="net.html#net_class_net_socket" class="type"><net.Socket></a> class, 1321a subclass of <a href="stream.html#stream_class_stream_duplex" class="type"><stream.Duplex></a>, unless the user specifies a socket 1322type other than <a href="net.html#net_class_net_socket" class="type"><net.Socket></a>.</p> 1323<p>After this event is emitted, the request's socket will not have a <code>'data'</code> 1324event listener, meaning it will need to be bound in order to handle data 1325sent to the server on that socket.</p> 1326<h4>Event: <code>'connection'</code><span><a class="mark" href="#http_event_connection" id="http_event_connection">#</a></span></h4> 1327<div class="api_metadata"> 1328<span>Added in: v0.1.0</span> 1329</div> 1330<ul> 1331<li><code>socket</code> <a href="stream.html#stream_class_stream_duplex" class="type"><stream.Duplex></a></li> 1332</ul> 1333<p>This event is emitted when a new TCP stream is established. <code>socket</code> is 1334typically an object of type <a href="net.html#net_class_net_socket"><code>net.Socket</code></a>. Usually users will not want to 1335access this event. In particular, the socket will not emit <code>'readable'</code> events 1336because of how the protocol parser attaches to the socket. The <code>socket</code> can 1337also be accessed at <code>request.socket</code>.</p> 1338<p>This event can also be explicitly emitted by users to inject connections 1339into the HTTP server. In that case, any <a href="stream.html#stream_class_stream_duplex"><code>Duplex</code></a> stream can be passed.</p> 1340<p>If <code>socket.setTimeout()</code> is called here, the timeout will be replaced with 1341<code>server.keepAliveTimeout</code> when the socket has served a request (if 1342<code>server.keepAliveTimeout</code> is non-zero).</p> 1343<p>This event is guaranteed to be passed an instance of the <a href="net.html#net_class_net_socket" class="type"><net.Socket></a> class, 1344a subclass of <a href="stream.html#stream_class_stream_duplex" class="type"><stream.Duplex></a>, unless the user specifies a socket 1345type other than <a href="net.html#net_class_net_socket" class="type"><net.Socket></a>.</p> 1346<h4>Event: <code>'request'</code><span><a class="mark" href="#http_event_request" id="http_event_request">#</a></span></h4> 1347<div class="api_metadata"> 1348<span>Added in: v0.1.0</span> 1349</div> 1350<ul> 1351<li><code>request</code> <a href="http.html#http_class_http_incomingmessage" class="type"><http.IncomingMessage></a></li> 1352<li><code>response</code> <a href="http.html#http_class_http_serverresponse" class="type"><http.ServerResponse></a></li> 1353</ul> 1354<p>Emitted each time there is a request. There may be multiple requests 1355per connection (in the case of HTTP Keep-Alive connections).</p> 1356<h4>Event: <code>'upgrade'</code><span><a class="mark" href="#http_event_upgrade_1" id="http_event_upgrade_1">#</a></span></h4> 1357<div class="api_metadata"> 1358<details class="changelog"><summary>History</summary> 1359<table> 1360<tbody><tr><th>Version</th><th>Changes</th></tr> 1361<tr><td>v10.0.0</td> 1362<td><p>Not listening to this event no longer causes the socket to be destroyed if a client sends an Upgrade header.</p></td></tr> 1363<tr><td>v0.1.94</td> 1364<td><p><span>Added in: v0.1.94</span></p></td></tr> 1365</tbody></table> 1366</details> 1367</div> 1368<ul> 1369<li><code>request</code> <a href="http.html#http_class_http_incomingmessage" class="type"><http.IncomingMessage></a> Arguments for the HTTP request, as it is in 1370the <a href="#http_event_request"><code>'request'</code></a> event</li> 1371<li><code>socket</code> <a href="stream.html#stream_class_stream_duplex" class="type"><stream.Duplex></a> Network socket between the server and client</li> 1372<li><code>head</code> <a href="buffer.html#buffer_class_buffer" class="type"><Buffer></a> The first packet of the upgraded stream (may be empty)</li> 1373</ul> 1374<p>Emitted each time a client requests an HTTP upgrade. Listening to this event 1375is optional and clients cannot insist on a protocol change.</p> 1376<p>After this event is emitted, the request's socket will not have a <code>'data'</code> 1377event listener, meaning it will need to be bound in order to handle data 1378sent to the server on that socket.</p> 1379<p>This event is guaranteed to be passed an instance of the <a href="net.html#net_class_net_socket" class="type"><net.Socket></a> class, 1380a subclass of <a href="stream.html#stream_class_stream_duplex" class="type"><stream.Duplex></a>, unless the user specifies a socket 1381type other than <a href="net.html#net_class_net_socket" class="type"><net.Socket></a>.</p> 1382<h4><code>server.close([callback])</code><span><a class="mark" href="#http_server_close_callback" id="http_server_close_callback">#</a></span></h4> 1383<div class="api_metadata"> 1384<span>Added in: v0.1.90</span> 1385</div> 1386<ul> 1387<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 1388</ul> 1389<p>Stops the server from accepting new connections. See <a href="net.html#net_server_close_callback"><code>net.Server.close()</code></a>.</p> 1390<h4><code>server.headersTimeout</code><span><a class="mark" href="#http_server_headerstimeout" id="http_server_headerstimeout">#</a></span></h4> 1391<div class="api_metadata"> 1392<span>Added in: v11.3.0, v10.14.0</span> 1393</div> 1394<ul> 1395<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> <strong>Default:</strong> <code>60000</code></li> 1396</ul> 1397<p>Limit the amount of time the parser will wait to receive the complete HTTP 1398headers.</p> 1399<p>In case of inactivity, the rules defined in <a href="#http_server_timeout"><code>server.timeout</code></a> apply. However, 1400that inactivity based timeout would still allow the connection to be kept open 1401if the headers are being sent very slowly (by default, up to a byte per 2 1402minutes). In order to prevent this, whenever header data arrives an additional 1403check is made that more than <code>server.headersTimeout</code> milliseconds has not 1404passed since the connection was established. If the check fails, a <code>'timeout'</code> 1405event is emitted on the server object, and (by default) the socket is destroyed. 1406See <a href="#http_server_timeout"><code>server.timeout</code></a> for more information on how timeout behavior can be 1407customized.</p> 1408<h4><code>server.listen()</code><span><a class="mark" href="#http_server_listen" id="http_server_listen">#</a></span></h4> 1409<p>Starts the HTTP server listening for connections. 1410This method is identical to <a href="net.html#net_server_listen"><code>server.listen()</code></a> from <a href="net.html#net_class_net_server"><code>net.Server</code></a>.</p> 1411<h4><code>server.listening</code><span><a class="mark" href="#http_server_listening" id="http_server_listening">#</a></span></h4> 1412<div class="api_metadata"> 1413<span>Added in: v5.7.0</span> 1414</div> 1415<ul> 1416<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> Indicates whether or not the server is listening for connections.</li> 1417</ul> 1418<h4><code>server.maxHeadersCount</code><span><a class="mark" href="#http_server_maxheaderscount" id="http_server_maxheaderscount">#</a></span></h4> 1419<div class="api_metadata"> 1420<span>Added in: v0.7.0</span> 1421</div> 1422<ul> 1423<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> <strong>Default:</strong> <code>2000</code></li> 1424</ul> 1425<p>Limits maximum incoming headers count. If set to 0, no limit will be applied.</p> 1426<h4><code>server.requestTimeout</code><span><a class="mark" href="#http_server_requesttimeout" id="http_server_requesttimeout">#</a></span></h4> 1427<div class="api_metadata"> 1428<span>Added in: v14.11.0</span> 1429</div> 1430<ul> 1431<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> <strong>Default:</strong> <code>0</code></li> 1432</ul> 1433<p>Sets the timeout value in milliseconds for receiving the entire request from 1434the client.</p> 1435<p>If the timeout expires, the server responds with status 408 without 1436forwarding the request to the request listener and then closes the connection.</p> 1437<p>It must be set to a non-zero value (e.g. 120 seconds) to protect against 1438potential Denial-of-Service attacks in case the server is deployed without a 1439reverse proxy in front.</p> 1440<h4><code>server.setTimeout([msecs][, callback])</code><span><a class="mark" href="#http_server_settimeout_msecs_callback" id="http_server_settimeout_msecs_callback">#</a></span></h4> 1441<div class="api_metadata"> 1442<details class="changelog"><summary>History</summary> 1443<table> 1444<tbody><tr><th>Version</th><th>Changes</th></tr> 1445<tr><td>v13.0.0</td> 1446<td><p>The default timeout changed from 120s to 0 (no timeout).</p></td></tr> 1447<tr><td>v0.9.12</td> 1448<td><p><span>Added in: v0.9.12</span></p></td></tr> 1449</tbody></table> 1450</details> 1451</div> 1452<ul> 1453<li><code>msecs</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> <strong>Default:</strong> 0 (no timeout)</li> 1454<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 1455<li>Returns: <a href="http.html#http_class_http_server" class="type"><http.Server></a></li> 1456</ul> 1457<p>Sets the timeout value for sockets, and emits a <code>'timeout'</code> event on 1458the Server object, passing the socket as an argument, if a timeout 1459occurs.</p> 1460<p>If there is a <code>'timeout'</code> event listener on the Server object, then it 1461will be called with the timed-out socket as an argument.</p> 1462<p>By default, the Server does not timeout sockets. However, if a callback 1463is assigned to the Server's <code>'timeout'</code> event, timeouts must be handled 1464explicitly.</p> 1465<h4><code>server.timeout</code><span><a class="mark" href="#http_server_timeout" id="http_server_timeout">#</a></span></h4> 1466<div class="api_metadata"> 1467<details class="changelog"><summary>History</summary> 1468<table> 1469<tbody><tr><th>Version</th><th>Changes</th></tr> 1470<tr><td>v13.0.0</td> 1471<td><p>The default timeout changed from 120s to 0 (no timeout).</p></td></tr> 1472<tr><td>v0.9.12</td> 1473<td><p><span>Added in: v0.9.12</span></p></td></tr> 1474</tbody></table> 1475</details> 1476</div> 1477<ul> 1478<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Timeout in milliseconds. <strong>Default:</strong> 0 (no timeout)</li> 1479</ul> 1480<p>The number of milliseconds of inactivity before a socket is presumed 1481to have timed out.</p> 1482<p>A value of <code>0</code> will disable the timeout behavior on incoming connections.</p> 1483<p>The socket timeout logic is set up on connection, so changing this 1484value only affects new connections to the server, not any existing connections.</p> 1485<h4><code>server.keepAliveTimeout</code><span><a class="mark" href="#http_server_keepalivetimeout" id="http_server_keepalivetimeout">#</a></span></h4> 1486<div class="api_metadata"> 1487<span>Added in: v8.0.0</span> 1488</div> 1489<ul> 1490<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Timeout in milliseconds. <strong>Default:</strong> <code>5000</code> (5 seconds).</li> 1491</ul> 1492<p>The number of milliseconds of inactivity a server needs to wait for additional 1493incoming data, after it has finished writing the last response, before a socket 1494will be destroyed. If the server receives new data before the keep-alive 1495timeout has fired, it will reset the regular inactivity timeout, i.e., 1496<a href="#http_server_timeout"><code>server.timeout</code></a>.</p> 1497<p>A value of <code>0</code> will disable the keep-alive timeout behavior on incoming 1498connections. 1499A value of <code>0</code> makes the http server behave similarly to Node.js versions prior 1500to 8.0.0, which did not have a keep-alive timeout.</p> 1501<p>The socket timeout logic is set up on connection, so changing this value only 1502affects new connections to the server, not any existing connections.</p> 1503</section><section><h3>Class: <code>http.ServerResponse</code><span><a class="mark" href="#http_class_http_serverresponse" id="http_class_http_serverresponse">#</a></span></h3> 1504<div class="api_metadata"> 1505<span>Added in: v0.1.17</span> 1506</div> 1507<ul> 1508<li>Extends: <a href="stream.html#stream_stream" class="type"><Stream></a></li> 1509</ul> 1510<p>This object is created internally by an HTTP server, not by the user. It is 1511passed as the second parameter to the <a href="#http_event_request"><code>'request'</code></a> event.</p> 1512<h4>Event: <code>'close'</code><span><a class="mark" href="#http_event_close_1" id="http_event_close_1">#</a></span></h4> 1513<div class="api_metadata"> 1514<span>Added in: v0.6.7</span> 1515</div> 1516<p>Indicates that the response is completed, or its underlying connection was 1517terminated prematurely (before the response completion).</p> 1518<h4>Event: <code>'finish'</code><span><a class="mark" href="#http_event_finish" id="http_event_finish">#</a></span></h4> 1519<div class="api_metadata"> 1520<span>Added in: v0.3.6</span> 1521</div> 1522<p>Emitted when the response has been sent. More specifically, this event is 1523emitted when the last segment of the response headers and body have been 1524handed off to the operating system for transmission over the network. It 1525does not imply that the client has received anything yet.</p> 1526<h4><code>response.addTrailers(headers)</code><span><a class="mark" href="#http_response_addtrailers_headers" id="http_response_addtrailers_headers">#</a></span></h4> 1527<div class="api_metadata"> 1528<span>Added in: v0.3.0</span> 1529</div> 1530<ul> 1531<li><code>headers</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 1532</ul> 1533<p>This method adds HTTP trailing headers (a header but at the end of the 1534message) to the response.</p> 1535<p>Trailers will <strong>only</strong> be emitted if chunked encoding is used for the 1536response; if it is not (e.g. if the request was HTTP/1.0), they will 1537be silently discarded.</p> 1538<p>HTTP requires the <code>Trailer</code> header to be sent in order to 1539emit trailers, with a list of the header fields in its value. E.g.,</p> 1540<pre><code class="language-js">response.<span class="hljs-title function_">writeHead</span>(<span class="hljs-number">200</span>, { <span class="hljs-string">'Content-Type'</span>: <span class="hljs-string">'text/plain'</span>, 1541 <span class="hljs-string">'Trailer'</span>: <span class="hljs-string">'Content-MD5'</span> }); 1542response.<span class="hljs-title function_">write</span>(fileData); 1543response.<span class="hljs-title function_">addTrailers</span>({ <span class="hljs-string">'Content-MD5'</span>: <span class="hljs-string">'7895bf4b8828b55ceaf47747b4bca667'</span> }); 1544response.<span class="hljs-title function_">end</span>();</code></pre> 1545<p>Attempting to set a header field name or value that contains invalid characters 1546will result in a <a href="errors.html#errors_class_typeerror"><code>TypeError</code></a> being thrown.</p> 1547<h4><code>response.connection</code><span><a class="mark" href="#http_response_connection" id="http_response_connection">#</a></span></h4> 1548<div class="api_metadata"> 1549<span>Added in: v0.3.0</span><span>Deprecated since: v13.0.0</span> 1550</div> 1551<p></p><div class="api_stability api_stability_0"><a href="documentation.html#documentation_stability_index">Stability: 0</a> - Deprecated. Use <a href="#http_response_socket"><code>response.socket</code></a>.</div><p></p> 1552<ul> 1553<li><a href="stream.html#stream_class_stream_duplex" class="type"><stream.Duplex></a></li> 1554</ul> 1555<p>See <a href="#http_response_socket"><code>response.socket</code></a>.</p> 1556<h4><code>response.cork()</code><span><a class="mark" href="#http_response_cork" id="http_response_cork">#</a></span></h4> 1557<div class="api_metadata"> 1558<span>Added in: v13.2.0, v12.16.0</span> 1559</div> 1560<p>See <a href="stream.html#stream_writable_cork"><code>writable.cork()</code></a>.</p> 1561<h4><code>response.end([data[, encoding]][, callback])</code><span><a class="mark" href="#http_response_end_data_encoding_callback" id="http_response_end_data_encoding_callback">#</a></span></h4> 1562<div class="api_metadata"> 1563<details class="changelog"><summary>History</summary> 1564<table> 1565<tbody><tr><th>Version</th><th>Changes</th></tr> 1566<tr><td>v10.0.0</td> 1567<td><p>This method now returns a reference to <code>ServerResponse</code>.</p></td></tr> 1568<tr><td>v0.1.90</td> 1569<td><p><span>Added in: v0.1.90</span></p></td></tr> 1570</tbody></table> 1571</details> 1572</div> 1573<ul> 1574<li><code>data</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> | <a href="buffer.html#buffer_class_buffer" class="type"><Buffer></a></li> 1575<li><code>encoding</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 1576<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 1577<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/this" class="type"><this></a></li> 1578</ul> 1579<p>This method signals to the server that all of the response headers and body 1580have been sent; that server should consider this message complete. 1581The method, <code>response.end()</code>, MUST be called on each response.</p> 1582<p>If <code>data</code> is specified, it is similar in effect to calling 1583<a href="#http_response_write_chunk_encoding_callback"><code>response.write(data, encoding)</code></a> followed by <code>response.end(callback)</code>.</p> 1584<p>If <code>callback</code> is specified, it will be called when the response stream 1585is finished.</p> 1586<h4><code>response.finished</code><span><a class="mark" href="#http_response_finished" id="http_response_finished">#</a></span></h4> 1587<div class="api_metadata"> 1588<span>Added in: v0.0.2</span><span>Deprecated since: v13.4.0, v12.16.0</span> 1589</div> 1590<p></p><div class="api_stability api_stability_0"><a href="documentation.html#documentation_stability_index">Stability: 0</a> - Deprecated. Use <a href="#http_response_writableended"><code>response.writableEnded</code></a>.</div><p></p> 1591<ul> 1592<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1593</ul> 1594<p>The <code>response.finished</code> property will be <code>true</code> if <a href="#http_response_end_data_encoding_callback"><code>response.end()</code></a> 1595has been called.</p> 1596<h4><code>response.flushHeaders()</code><span><a class="mark" href="#http_response_flushheaders" id="http_response_flushheaders">#</a></span></h4> 1597<div class="api_metadata"> 1598<span>Added in: v1.6.0</span> 1599</div> 1600<p>Flushes the response headers. See also: <a href="#http_request_flushheaders"><code>request.flushHeaders()</code></a>.</p> 1601<h4><code>response.getHeader(name)</code><span><a class="mark" href="#http_response_getheader_name" id="http_response_getheader_name">#</a></span></h4> 1602<div class="api_metadata"> 1603<span>Added in: v0.4.0</span> 1604</div> 1605<ul> 1606<li><code>name</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 1607<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1608</ul> 1609<p>Reads out a header that's already been queued but not sent to the client. 1610The name is case-insensitive. The type of the return value depends 1611on the arguments provided to <a href="#http_response_setheader_name_value"><code>response.setHeader()</code></a>.</p> 1612<pre><code class="language-js">response.<span class="hljs-title function_">setHeader</span>(<span class="hljs-string">'Content-Type'</span>, <span class="hljs-string">'text/html'</span>); 1613response.<span class="hljs-title function_">setHeader</span>(<span class="hljs-string">'Content-Length'</span>, <span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">byteLength</span>(body)); 1614response.<span class="hljs-title function_">setHeader</span>(<span class="hljs-string">'Set-Cookie'</span>, [<span class="hljs-string">'type=ninja'</span>, <span class="hljs-string">'language=javascript'</span>]); 1615<span class="hljs-keyword">const</span> contentType = response.<span class="hljs-title function_">getHeader</span>(<span class="hljs-string">'content-type'</span>); 1616<span class="hljs-comment">// contentType is 'text/html'</span> 1617<span class="hljs-keyword">const</span> contentLength = response.<span class="hljs-title function_">getHeader</span>(<span class="hljs-string">'Content-Length'</span>); 1618<span class="hljs-comment">// contentLength is of type number</span> 1619<span class="hljs-keyword">const</span> setCookie = response.<span class="hljs-title function_">getHeader</span>(<span class="hljs-string">'set-cookie'</span>); 1620<span class="hljs-comment">// setCookie is of type string[]</span></code></pre> 1621<h4><code>response.getHeaderNames()</code><span><a class="mark" href="#http_response_getheadernames" id="http_response_getheadernames">#</a></span></h4> 1622<div class="api_metadata"> 1623<span>Added in: v7.7.0</span> 1624</div> 1625<ul> 1626<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string[]></a></li> 1627</ul> 1628<p>Returns an array containing the unique names of the current outgoing headers. 1629All header names are lowercase.</p> 1630<pre><code class="language-js">response.<span class="hljs-title function_">setHeader</span>(<span class="hljs-string">'Foo'</span>, <span class="hljs-string">'bar'</span>); 1631response.<span class="hljs-title function_">setHeader</span>(<span class="hljs-string">'Set-Cookie'</span>, [<span class="hljs-string">'foo=bar'</span>, <span class="hljs-string">'bar=baz'</span>]); 1632 1633<span class="hljs-keyword">const</span> headerNames = response.<span class="hljs-title function_">getHeaderNames</span>(); 1634<span class="hljs-comment">// headerNames === ['foo', 'set-cookie']</span></code></pre> 1635<h4><code>response.getHeaders()</code><span><a class="mark" href="#http_response_getheaders" id="http_response_getheaders">#</a></span></h4> 1636<div class="api_metadata"> 1637<span>Added in: v7.7.0</span> 1638</div> 1639<ul> 1640<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 1641</ul> 1642<p>Returns a shallow copy of the current outgoing headers. Since a shallow copy 1643is used, array values may be mutated without additional calls to various 1644header-related http module methods. The keys of the returned object are the 1645header names and the values are the respective header values. All header names 1646are lowercase.</p> 1647<p>The object returned by the <code>response.getHeaders()</code> method <em>does not</em> 1648prototypically inherit from the JavaScript <code>Object</code>. This means that typical 1649<code>Object</code> methods such as <code>obj.toString()</code>, <code>obj.hasOwnProperty()</code>, and others 1650are not defined and <em>will not work</em>.</p> 1651<pre><code class="language-js">response.<span class="hljs-title function_">setHeader</span>(<span class="hljs-string">'Foo'</span>, <span class="hljs-string">'bar'</span>); 1652response.<span class="hljs-title function_">setHeader</span>(<span class="hljs-string">'Set-Cookie'</span>, [<span class="hljs-string">'foo=bar'</span>, <span class="hljs-string">'bar=baz'</span>]); 1653 1654<span class="hljs-keyword">const</span> headers = response.<span class="hljs-title function_">getHeaders</span>(); 1655<span class="hljs-comment">// headers === { foo: 'bar', 'set-cookie': ['foo=bar', 'bar=baz'] }</span></code></pre> 1656<h4><code>response.hasHeader(name)</code><span><a class="mark" href="#http_response_hasheader_name" id="http_response_hasheader_name">#</a></span></h4> 1657<div class="api_metadata"> 1658<span>Added in: v7.7.0</span> 1659</div> 1660<ul> 1661<li><code>name</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 1662<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1663</ul> 1664<p>Returns <code>true</code> if the header identified by <code>name</code> is currently set in the 1665outgoing headers. The header name matching is case-insensitive.</p> 1666<pre><code class="language-js"><span class="hljs-keyword">const</span> hasContentType = response.<span class="hljs-title function_">hasHeader</span>(<span class="hljs-string">'content-type'</span>);</code></pre> 1667<h4><code>response.headersSent</code><span><a class="mark" href="#http_response_headerssent" id="http_response_headerssent">#</a></span></h4> 1668<div class="api_metadata"> 1669<span>Added in: v0.9.3</span> 1670</div> 1671<ul> 1672<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1673</ul> 1674<p>Boolean (read-only). True if headers were sent, false otherwise.</p> 1675<h4><code>response.removeHeader(name)</code><span><a class="mark" href="#http_response_removeheader_name" id="http_response_removeheader_name">#</a></span></h4> 1676<div class="api_metadata"> 1677<span>Added in: v0.4.0</span> 1678</div> 1679<ul> 1680<li><code>name</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 1681</ul> 1682<p>Removes a header that's queued for implicit sending.</p> 1683<pre><code class="language-js">response.<span class="hljs-title function_">removeHeader</span>(<span class="hljs-string">'Content-Encoding'</span>);</code></pre> 1684<h4><code>response.sendDate</code><span><a class="mark" href="#http_response_senddate" id="http_response_senddate">#</a></span></h4> 1685<div class="api_metadata"> 1686<span>Added in: v0.7.5</span> 1687</div> 1688<ul> 1689<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1690</ul> 1691<p>When true, the Date header will be automatically generated and sent in 1692the response if it is not already present in the headers. Defaults to true.</p> 1693<p>This should only be disabled for testing; HTTP requires the Date header 1694in responses.</p> 1695<h4><code>response.setHeader(name, value)</code><span><a class="mark" href="#http_response_setheader_name_value" id="http_response_setheader_name_value">#</a></span></h4> 1696<div class="api_metadata"> 1697<span>Added in: v0.4.0</span> 1698</div> 1699<ul> 1700<li><code>name</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 1701<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1702<li>Returns: <a href="http.html#http_class_http_serverresponse" class="type"><http.ServerResponse></a></li> 1703</ul> 1704<p>Returns the response object.</p> 1705<p>Sets a single header value for implicit headers. If this header already exists 1706in the to-be-sent headers, its value will be replaced. Use an array of strings 1707here to send multiple headers with the same name. Non-string values will be 1708stored without modification. Therefore, <a href="#http_response_getheader_name"><code>response.getHeader()</code></a> may return 1709non-string values. However, the non-string values will be converted to strings 1710for network transmission. The same response object is returned to the caller, 1711to enable call chaining.</p> 1712<pre><code class="language-js">response.<span class="hljs-title function_">setHeader</span>(<span class="hljs-string">'Content-Type'</span>, <span class="hljs-string">'text/html'</span>);</code></pre> 1713<p>or</p> 1714<pre><code class="language-js">response.<span class="hljs-title function_">setHeader</span>(<span class="hljs-string">'Set-Cookie'</span>, [<span class="hljs-string">'type=ninja'</span>, <span class="hljs-string">'language=javascript'</span>]);</code></pre> 1715<p>Attempting to set a header field name or value that contains invalid characters 1716will result in a <a href="errors.html#errors_class_typeerror"><code>TypeError</code></a> being thrown.</p> 1717<p>When headers have been set with <a href="#http_response_setheader_name_value"><code>response.setHeader()</code></a>, they will be merged 1718with any headers passed to <a href="#http_response_writehead_statuscode_statusmessage_headers"><code>response.writeHead()</code></a>, with the headers passed 1719to <a href="#http_response_writehead_statuscode_statusmessage_headers"><code>response.writeHead()</code></a> given precedence.</p> 1720<pre><code class="language-js"><span class="hljs-comment">// Returns content-type = text/plain</span> 1721<span class="hljs-keyword">const</span> server = http.<span class="hljs-title function_">createServer</span>(<span class="hljs-function">(<span class="hljs-params">req, res</span>) =></span> { 1722 res.<span class="hljs-title function_">setHeader</span>(<span class="hljs-string">'Content-Type'</span>, <span class="hljs-string">'text/html'</span>); 1723 res.<span class="hljs-title function_">setHeader</span>(<span class="hljs-string">'X-Foo'</span>, <span class="hljs-string">'bar'</span>); 1724 res.<span class="hljs-title function_">writeHead</span>(<span class="hljs-number">200</span>, { <span class="hljs-string">'Content-Type'</span>: <span class="hljs-string">'text/plain'</span> }); 1725 res.<span class="hljs-title function_">end</span>(<span class="hljs-string">'ok'</span>); 1726});</code></pre> 1727<p>If <a href="#http_response_writehead_statuscode_statusmessage_headers"><code>response.writeHead()</code></a> method is called and this method has not been 1728called, it will directly write the supplied header values onto the network 1729channel without caching internally, and the <a href="#http_response_getheader_name"><code>response.getHeader()</code></a> on the 1730header will not yield the expected result. If progressive population of headers 1731is desired with potential future retrieval and modification, use 1732<a href="#http_response_setheader_name_value"><code>response.setHeader()</code></a> instead of <a href="#http_response_writehead_statuscode_statusmessage_headers"><code>response.writeHead()</code></a>.</p> 1733<h4><code>response.setTimeout(msecs[, callback])</code><span><a class="mark" href="#http_response_settimeout_msecs_callback" id="http_response_settimeout_msecs_callback">#</a></span></h4> 1734<div class="api_metadata"> 1735<span>Added in: v0.9.12</span> 1736</div> 1737<ul> 1738<li><code>msecs</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 1739<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 1740<li>Returns: <a href="http.html#http_class_http_serverresponse" class="type"><http.ServerResponse></a></li> 1741</ul> 1742<p>Sets the Socket's timeout value to <code>msecs</code>. If a callback is 1743provided, then it is added as a listener on the <code>'timeout'</code> event on 1744the response object.</p> 1745<p>If no <code>'timeout'</code> listener is added to the request, the response, or 1746the server, then sockets are destroyed when they time out. If a handler is 1747assigned to the request, the response, or the server's <code>'timeout'</code> events, 1748timed out sockets must be handled explicitly.</p> 1749<h4><code>response.socket</code><span><a class="mark" href="#http_response_socket" id="http_response_socket">#</a></span></h4> 1750<div class="api_metadata"> 1751<span>Added in: v0.3.0</span> 1752</div> 1753<ul> 1754<li><a href="stream.html#stream_class_stream_duplex" class="type"><stream.Duplex></a></li> 1755</ul> 1756<p>Reference to the underlying socket. Usually users will not want to access 1757this property. In particular, the socket will not emit <code>'readable'</code> events 1758because of how the protocol parser attaches to the socket. After 1759<code>response.end()</code>, the property is nulled.</p> 1760<pre><code class="language-js"><span class="hljs-keyword">const</span> http = <span class="hljs-built_in">require</span>(<span class="hljs-string">'http'</span>); 1761<span class="hljs-keyword">const</span> server = http.<span class="hljs-title function_">createServer</span>(<span class="hljs-function">(<span class="hljs-params">req, res</span>) =></span> { 1762 <span class="hljs-keyword">const</span> ip = res.<span class="hljs-property">socket</span>.<span class="hljs-property">remoteAddress</span>; 1763 <span class="hljs-keyword">const</span> port = res.<span class="hljs-property">socket</span>.<span class="hljs-property">remotePort</span>; 1764 res.<span class="hljs-title function_">end</span>(<span class="hljs-string">`Your IP address is <span class="hljs-subst">${ip}</span> and your source port is <span class="hljs-subst">${port}</span>.`</span>); 1765}).<span class="hljs-title function_">listen</span>(<span class="hljs-number">3000</span>);</code></pre> 1766<p>This property is guaranteed to be an instance of the <a href="net.html#net_class_net_socket" class="type"><net.Socket></a> class, 1767a subclass of <a href="stream.html#stream_class_stream_duplex" class="type"><stream.Duplex></a>, unless the user specified a socket 1768type other than <a href="net.html#net_class_net_socket" class="type"><net.Socket></a>.</p> 1769<h4><code>response.statusCode</code><span><a class="mark" href="#http_response_statuscode" id="http_response_statuscode">#</a></span></h4> 1770<div class="api_metadata"> 1771<span>Added in: v0.4.0</span> 1772</div> 1773<ul> 1774<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> <strong>Default:</strong> <code>200</code></li> 1775</ul> 1776<p>When using implicit headers (not calling <a href="#http_response_writehead_statuscode_statusmessage_headers"><code>response.writeHead()</code></a> explicitly), 1777this property controls the status code that will be sent to the client when 1778the headers get flushed.</p> 1779<pre><code class="language-js">response.<span class="hljs-property">statusCode</span> = <span class="hljs-number">404</span>;</code></pre> 1780<p>After response header was sent to the client, this property indicates the 1781status code which was sent out.</p> 1782<h4><code>response.statusMessage</code><span><a class="mark" href="#http_response_statusmessage" id="http_response_statusmessage">#</a></span></h4> 1783<div class="api_metadata"> 1784<span>Added in: v0.11.8</span> 1785</div> 1786<ul> 1787<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 1788</ul> 1789<p>When using implicit headers (not calling <a href="#http_response_writehead_statuscode_statusmessage_headers"><code>response.writeHead()</code></a> explicitly), 1790this property controls the status message that will be sent to the client when 1791the headers get flushed. If this is left as <code>undefined</code> then the standard 1792message for the status code will be used.</p> 1793<pre><code class="language-js">response.<span class="hljs-property">statusMessage</span> = <span class="hljs-string">'Not found'</span>;</code></pre> 1794<p>After response header was sent to the client, this property indicates the 1795status message which was sent out.</p> 1796<h4><code>response.uncork()</code><span><a class="mark" href="#http_response_uncork" id="http_response_uncork">#</a></span></h4> 1797<div class="api_metadata"> 1798<span>Added in: v13.2.0, v12.16.0</span> 1799</div> 1800<p>See <a href="stream.html#stream_writable_uncork"><code>writable.uncork()</code></a>.</p> 1801<h4><code>response.writableEnded</code><span><a class="mark" href="#http_response_writableended" id="http_response_writableended">#</a></span></h4> 1802<div class="api_metadata"> 1803<span>Added in: v12.9.0</span> 1804</div> 1805<ul> 1806<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1807</ul> 1808<p>Is <code>true</code> after <a href="#http_response_end_data_encoding_callback"><code>response.end()</code></a> has been called. This property 1809does not indicate whether the data has been flushed, for this use 1810<a href="#http_response_writablefinished"><code>response.writableFinished</code></a> instead.</p> 1811<h4><code>response.writableFinished</code><span><a class="mark" href="#http_response_writablefinished" id="http_response_writablefinished">#</a></span></h4> 1812<div class="api_metadata"> 1813<span>Added in: v12.7.0</span> 1814</div> 1815<ul> 1816<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1817</ul> 1818<p>Is <code>true</code> if all data has been flushed to the underlying system, immediately 1819before the <a href="#http_event_finish"><code>'finish'</code></a> event is emitted.</p> 1820<h4><code>response.write(chunk[, encoding][, callback])</code><span><a class="mark" href="#http_response_write_chunk_encoding_callback" id="http_response_write_chunk_encoding_callback">#</a></span></h4> 1821<div class="api_metadata"> 1822<span>Added in: v0.1.29</span> 1823</div> 1824<ul> 1825<li><code>chunk</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> | <a href="buffer.html#buffer_class_buffer" class="type"><Buffer></a></li> 1826<li><code>encoding</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> <strong>Default:</strong> <code>'utf8'</code></li> 1827<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 1828<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1829</ul> 1830<p>If this method is called and <a href="#http_response_writehead_statuscode_statusmessage_headers"><code>response.writeHead()</code></a> has not been called, 1831it will switch to implicit header mode and flush the implicit headers.</p> 1832<p>This sends a chunk of the response body. This method may 1833be called multiple times to provide successive parts of the body.</p> 1834<p>In the <code>http</code> module, the response body is omitted when the 1835request is a HEAD request. Similarly, the <code>204</code> and <code>304</code> responses 1836<em>must not</em> include a message body.</p> 1837<p><code>chunk</code> can be a string or a buffer. If <code>chunk</code> is a string, 1838the second parameter specifies how to encode it into a byte stream. 1839<code>callback</code> will be called when this chunk of data is flushed.</p> 1840<p>This is the raw HTTP body and has nothing to do with higher-level multi-part 1841body encodings that may be used.</p> 1842<p>The first time <a href="#http_response_write_chunk_encoding_callback"><code>response.write()</code></a> is called, it will send the buffered 1843header information and the first chunk of the body to the client. The second 1844time <a href="#http_response_write_chunk_encoding_callback"><code>response.write()</code></a> is called, Node.js assumes data will be streamed, 1845and sends the new data separately. That is, the response is buffered up to the 1846first chunk of the body.</p> 1847<p>Returns <code>true</code> if the entire data was flushed successfully to the kernel 1848buffer. Returns <code>false</code> if all or part of the data was queued in user memory. 1849<code>'drain'</code> will be emitted when the buffer is free again.</p> 1850<h4><code>response.writeContinue()</code><span><a class="mark" href="#http_response_writecontinue" id="http_response_writecontinue">#</a></span></h4> 1851<div class="api_metadata"> 1852<span>Added in: v0.3.0</span> 1853</div> 1854<p>Sends a HTTP/1.1 100 Continue message to the client, indicating that 1855the request body should be sent. See the <a href="#http_event_checkcontinue"><code>'checkContinue'</code></a> event on 1856<code>Server</code>.</p> 1857<h4><code>response.writeHead(statusCode[, statusMessage][, headers])</code><span><a class="mark" href="#http_response_writehead_statuscode_statusmessage_headers" id="http_response_writehead_statuscode_statusmessage_headers">#</a></span></h4> 1858<div class="api_metadata"> 1859<details class="changelog"><summary>History</summary> 1860<table> 1861<tbody><tr><th>Version</th><th>Changes</th></tr> 1862<tr><td>v14.14.0</td> 1863<td><p>Allow passing headers as an array.</p></td></tr> 1864<tr><td>v11.10.0, v10.17.0</td> 1865<td><p>Return <code>this</code> from <code>writeHead()</code> to allow chaining with <code>end()</code>.</p></td></tr> 1866<tr><td>v5.11.0, v4.4.5</td> 1867<td><p>A <code>RangeError</code> is thrown if <code>statusCode</code> is not a number in the range <code>[100, 999]</code>.</p></td></tr> 1868<tr><td>v0.1.30</td> 1869<td><p><span>Added in: v0.1.30</span></p></td></tr> 1870</tbody></table> 1871</details> 1872</div> 1873<ul> 1874<li><code>statusCode</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 1875<li><code>statusMessage</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 1876<li><code>headers</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="type"><Array></a></li> 1877<li>Returns: <a href="http.html#http_class_http_serverresponse" class="type"><http.ServerResponse></a></li> 1878</ul> 1879<p>Sends a response header to the request. The status code is a 3-digit HTTP 1880status code, like <code>404</code>. The last argument, <code>headers</code>, are the response headers. 1881Optionally one can give a human-readable <code>statusMessage</code> as the second 1882argument.</p> 1883<p><code>headers</code> may be an <code>Array</code> where the keys and values are in the same list. 1884It is <em>not</em> a list of tuples. So, the even-numbered offsets are key values, 1885and the odd-numbered offsets are the associated values. The array is in the same 1886format as <code>request.rawHeaders</code>.</p> 1887<p>Returns a reference to the <code>ServerResponse</code>, so that calls can be chained.</p> 1888<pre><code class="language-js"><span class="hljs-keyword">const</span> body = <span class="hljs-string">'hello world'</span>; 1889response 1890 .<span class="hljs-title function_">writeHead</span>(<span class="hljs-number">200</span>, { 1891 <span class="hljs-string">'Content-Length'</span>: <span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">byteLength</span>(body), 1892 <span class="hljs-string">'Content-Type'</span>: <span class="hljs-string">'text/plain'</span> 1893 }) 1894 .<span class="hljs-title function_">end</span>(body);</code></pre> 1895<p>This method must only be called once on a message and it must 1896be called before <a href="#http_response_end_data_encoding_callback"><code>response.end()</code></a> is called.</p> 1897<p>If <a href="#http_response_write_chunk_encoding_callback"><code>response.write()</code></a> or <a href="#http_response_end_data_encoding_callback"><code>response.end()</code></a> are called before calling 1898this, the implicit/mutable headers will be calculated and call this function.</p> 1899<p>When headers have been set with <a href="#http_response_setheader_name_value"><code>response.setHeader()</code></a>, they will be merged 1900with any headers passed to <a href="#http_response_writehead_statuscode_statusmessage_headers"><code>response.writeHead()</code></a>, with the headers passed 1901to <a href="#http_response_writehead_statuscode_statusmessage_headers"><code>response.writeHead()</code></a> given precedence.</p> 1902<p>If this method is called and <a href="#http_response_setheader_name_value"><code>response.setHeader()</code></a> has not been called, 1903it will directly write the supplied header values onto the network channel 1904without caching internally, and the <a href="#http_response_getheader_name"><code>response.getHeader()</code></a> on the header 1905will not yield the expected result. If progressive population of headers is 1906desired with potential future retrieval and modification, use 1907<a href="#http_response_setheader_name_value"><code>response.setHeader()</code></a> instead.</p> 1908<pre><code class="language-js"><span class="hljs-comment">// Returns content-type = text/plain</span> 1909<span class="hljs-keyword">const</span> server = http.<span class="hljs-title function_">createServer</span>(<span class="hljs-function">(<span class="hljs-params">req, res</span>) =></span> { 1910 res.<span class="hljs-title function_">setHeader</span>(<span class="hljs-string">'Content-Type'</span>, <span class="hljs-string">'text/html'</span>); 1911 res.<span class="hljs-title function_">setHeader</span>(<span class="hljs-string">'X-Foo'</span>, <span class="hljs-string">'bar'</span>); 1912 res.<span class="hljs-title function_">writeHead</span>(<span class="hljs-number">200</span>, { <span class="hljs-string">'Content-Type'</span>: <span class="hljs-string">'text/plain'</span> }); 1913 res.<span class="hljs-title function_">end</span>(<span class="hljs-string">'ok'</span>); 1914});</code></pre> 1915<p><code>Content-Length</code> is given in bytes, not characters. Use 1916<a href="buffer.html#buffer_static_method_buffer_bytelength_string_encoding"><code>Buffer.byteLength()</code></a> to determine the length of the body in bytes. Node.js 1917does not check whether <code>Content-Length</code> and the length of the body which has 1918been transmitted are equal or not.</p> 1919<p>Attempting to set a header field name or value that contains invalid characters 1920will result in a <a href="errors.html#errors_class_typeerror"><code>TypeError</code></a> being thrown.</p> 1921<h4><code>response.writeProcessing()</code><span><a class="mark" href="#http_response_writeprocessing" id="http_response_writeprocessing">#</a></span></h4> 1922<div class="api_metadata"> 1923<span>Added in: v10.0.0</span> 1924</div> 1925<p>Sends a HTTP/1.1 102 Processing message to the client, indicating that 1926the request body should be sent.</p> 1927</section><section><h3>Class: <code>http.IncomingMessage</code><span><a class="mark" href="#http_class_http_incomingmessage" id="http_class_http_incomingmessage">#</a></span></h3> 1928<div class="api_metadata"> 1929<details class="changelog"><summary>History</summary> 1930<table> 1931<tbody><tr><th>Version</th><th>Changes</th></tr> 1932<tr><td>v13.1.0, v12.16.0</td> 1933<td><p>The <code>readableHighWaterMark</code> value mirrors that of the socket.</p></td></tr> 1934<tr><td>v0.1.17</td> 1935<td><p><span>Added in: v0.1.17</span></p></td></tr> 1936</tbody></table> 1937</details> 1938</div> 1939<ul> 1940<li>Extends: <a href="stream.html#stream_class_stream_readable" class="type"><stream.Readable></a></li> 1941</ul> 1942<p>An <code>IncomingMessage</code> object is created by <a href="#http_class_http_server"><code>http.Server</code></a> or 1943<a href="#http_class_http_clientrequest"><code>http.ClientRequest</code></a> and passed as the first argument to the <a href="#http_event_request"><code>'request'</code></a> 1944and <a href="#http_event_response"><code>'response'</code></a> event respectively. It may be used to access response 1945status, headers and data.</p> 1946<h4>Event: <code>'aborted'</code><span><a class="mark" href="#http_event_aborted" id="http_event_aborted">#</a></span></h4> 1947<div class="api_metadata"> 1948<span>Added in: v0.3.8</span> 1949</div> 1950<p>Emitted when the request has been aborted.</p> 1951<h4>Event: <code>'close'</code><span><a class="mark" href="#http_event_close_2" id="http_event_close_2">#</a></span></h4> 1952<div class="api_metadata"> 1953<span>Added in: v0.4.2</span> 1954</div> 1955<p>Indicates that the underlying connection was closed.</p> 1956<h4><code>message.aborted</code><span><a class="mark" href="#http_message_aborted" id="http_message_aborted">#</a></span></h4> 1957<div class="api_metadata"> 1958<span>Added in: v10.1.0</span> 1959</div> 1960<ul> 1961<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1962</ul> 1963<p>The <code>message.aborted</code> property will be <code>true</code> if the request has 1964been aborted.</p> 1965<h4><code>message.complete</code><span><a class="mark" href="#http_message_complete" id="http_message_complete">#</a></span></h4> 1966<div class="api_metadata"> 1967<span>Added in: v0.3.0</span> 1968</div> 1969<ul> 1970<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1971</ul> 1972<p>The <code>message.complete</code> property will be <code>true</code> if a complete HTTP message has 1973been received and successfully parsed.</p> 1974<p>This property is particularly useful as a means of determining if a client or 1975server fully transmitted a message before a connection was terminated:</p> 1976<pre><code class="language-js"><span class="hljs-keyword">const</span> req = http.<span class="hljs-title function_">request</span>({ 1977 <span class="hljs-attr">host</span>: <span class="hljs-string">'127.0.0.1'</span>, 1978 <span class="hljs-attr">port</span>: <span class="hljs-number">8080</span>, 1979 <span class="hljs-attr">method</span>: <span class="hljs-string">'POST'</span> 1980}, <span class="hljs-function">(<span class="hljs-params">res</span>) =></span> { 1981 res.<span class="hljs-title function_">resume</span>(); 1982 res.<span class="hljs-title function_">on</span>(<span class="hljs-string">'end'</span>, <span class="hljs-function">() =></span> { 1983 <span class="hljs-keyword">if</span> (!res.<span class="hljs-property">complete</span>) 1984 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">error</span>( 1985 <span class="hljs-string">'The connection was terminated while the message was still being sent'</span>); 1986 }); 1987});</code></pre> 1988<h4><code>message.destroy([error])</code><span><a class="mark" href="#http_message_destroy_error" id="http_message_destroy_error">#</a></span></h4> 1989<div class="api_metadata"> 1990<details class="changelog"><summary>History</summary> 1991<table> 1992<tbody><tr><th>Version</th><th>Changes</th></tr> 1993<tr><td>v14.5.0</td> 1994<td><p>The function returns <code>this</code> for consistency with other Readable streams.</p></td></tr> 1995<tr><td>v0.3.0</td> 1996<td><p><span>Added in: v0.3.0</span></p></td></tr> 1997</tbody></table> 1998</details> 1999</div> 2000<ul> 2001<li><code>error</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" class="type"><Error></a></li> 2002<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/this" class="type"><this></a></li> 2003</ul> 2004<p>Calls <code>destroy()</code> on the socket that received the <code>IncomingMessage</code>. If <code>error</code> 2005is provided, an <code>'error'</code> event is emitted on the socket and <code>error</code> is passed 2006as an argument to any listeners on the event.</p> 2007<h4><code>message.headers</code><span><a class="mark" href="#http_message_headers" id="http_message_headers">#</a></span></h4> 2008<div class="api_metadata"> 2009<span>Added in: v0.1.5</span> 2010</div> 2011<ul> 2012<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 2013</ul> 2014<p>The request/response headers object.</p> 2015<p>Key-value pairs of header names and values. Header names are lower-cased.</p> 2016<pre><code class="language-js"><span class="hljs-comment">// Prints something like:</span> 2017<span class="hljs-comment">//</span> 2018<span class="hljs-comment">// { 'user-agent': 'curl/7.22.0',</span> 2019<span class="hljs-comment">// host: '127.0.0.1:8000',</span> 2020<span class="hljs-comment">// accept: '*/*' }</span> 2021<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(request.<span class="hljs-property">headers</span>);</code></pre> 2022<p>Duplicates in raw headers are handled in the following ways, depending on the 2023header name:</p> 2024<ul> 2025<li>Duplicates of <code>age</code>, <code>authorization</code>, <code>content-length</code>, <code>content-type</code>, 2026<code>etag</code>, <code>expires</code>, <code>from</code>, <code>host</code>, <code>if-modified-since</code>, <code>if-unmodified-since</code>, 2027<code>last-modified</code>, <code>location</code>, <code>max-forwards</code>, <code>proxy-authorization</code>, <code>referer</code>, 2028<code>retry-after</code>, <code>server</code>, or <code>user-agent</code> are discarded.</li> 2029<li><code>set-cookie</code> is always an array. Duplicates are added to the array.</li> 2030<li>For duplicate <code>cookie</code> headers, the values are joined together with '; '.</li> 2031<li>For all other headers, the values are joined together with ', '.</li> 2032</ul> 2033<h4><code>message.httpVersion</code><span><a class="mark" href="#http_message_httpversion" id="http_message_httpversion">#</a></span></h4> 2034<div class="api_metadata"> 2035<span>Added in: v0.1.1</span> 2036</div> 2037<ul> 2038<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 2039</ul> 2040<p>In case of server request, the HTTP version sent by the client. In the case of 2041client response, the HTTP version of the connected-to server. 2042Probably either <code>'1.1'</code> or <code>'1.0'</code>.</p> 2043<p>Also <code>message.httpVersionMajor</code> is the first integer and 2044<code>message.httpVersionMinor</code> is the second.</p> 2045<h4><code>message.method</code><span><a class="mark" href="#http_message_method" id="http_message_method">#</a></span></h4> 2046<div class="api_metadata"> 2047<span>Added in: v0.1.1</span> 2048</div> 2049<ul> 2050<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 2051</ul> 2052<p><strong>Only valid for request obtained from <a href="#http_class_http_server"><code>http.Server</code></a>.</strong></p> 2053<p>The request method as a string. Read only. Examples: <code>'GET'</code>, <code>'DELETE'</code>.</p> 2054<h4><code>message.rawHeaders</code><span><a class="mark" href="#http_message_rawheaders" id="http_message_rawheaders">#</a></span></h4> 2055<div class="api_metadata"> 2056<span>Added in: v0.11.6</span> 2057</div> 2058<ul> 2059<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string[]></a></li> 2060</ul> 2061<p>The raw request/response headers list exactly as they were received.</p> 2062<p>The keys and values are in the same list. It is <em>not</em> a 2063list of tuples. So, the even-numbered offsets are key values, and the 2064odd-numbered offsets are the associated values.</p> 2065<p>Header names are not lowercased, and duplicates are not merged.</p> 2066<pre><code class="language-js"><span class="hljs-comment">// Prints something like:</span> 2067<span class="hljs-comment">//</span> 2068<span class="hljs-comment">// [ 'user-agent',</span> 2069<span class="hljs-comment">// 'this is invalid because there can be only one',</span> 2070<span class="hljs-comment">// 'User-Agent',</span> 2071<span class="hljs-comment">// 'curl/7.22.0',</span> 2072<span class="hljs-comment">// 'Host',</span> 2073<span class="hljs-comment">// '127.0.0.1:8000',</span> 2074<span class="hljs-comment">// 'ACCEPT',</span> 2075<span class="hljs-comment">// '*/*' ]</span> 2076<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(request.<span class="hljs-property">rawHeaders</span>);</code></pre> 2077<h4><code>message.rawTrailers</code><span><a class="mark" href="#http_message_rawtrailers" id="http_message_rawtrailers">#</a></span></h4> 2078<div class="api_metadata"> 2079<span>Added in: v0.11.6</span> 2080</div> 2081<ul> 2082<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string[]></a></li> 2083</ul> 2084<p>The raw request/response trailer keys and values exactly as they were 2085received. Only populated at the <code>'end'</code> event.</p> 2086<h4><code>message.setTimeout(msecs[, callback])</code><span><a class="mark" href="#http_message_settimeout_msecs_callback" id="http_message_settimeout_msecs_callback">#</a></span></h4> 2087<div class="api_metadata"> 2088<span>Added in: v0.5.9</span> 2089</div> 2090<ul> 2091<li><code>msecs</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 2092<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 2093<li>Returns: <a href="http.html#http_class_http_incomingmessage" class="type"><http.IncomingMessage></a></li> 2094</ul> 2095<p>Calls <code>message.socket.setTimeout(msecs, callback)</code>.</p> 2096<h4><code>message.socket</code><span><a class="mark" href="#http_message_socket" id="http_message_socket">#</a></span></h4> 2097<div class="api_metadata"> 2098<span>Added in: v0.3.0</span> 2099</div> 2100<ul> 2101<li><a href="stream.html#stream_class_stream_duplex" class="type"><stream.Duplex></a></li> 2102</ul> 2103<p>The <a href="net.html#net_class_net_socket"><code>net.Socket</code></a> object associated with the connection.</p> 2104<p>With HTTPS support, use <a href="tls.html#tls_tlssocket_getpeercertificate_detailed"><code>request.socket.getPeerCertificate()</code></a> to obtain the 2105client's authentication details.</p> 2106<p>This property is guaranteed to be an instance of the <a href="net.html#net_class_net_socket" class="type"><net.Socket></a> class, 2107a subclass of <a href="stream.html#stream_class_stream_duplex" class="type"><stream.Duplex></a>, unless the user specified a socket 2108type other than <a href="net.html#net_class_net_socket" class="type"><net.Socket></a>.</p> 2109<h4><code>message.statusCode</code><span><a class="mark" href="#http_message_statuscode" id="http_message_statuscode">#</a></span></h4> 2110<div class="api_metadata"> 2111<span>Added in: v0.1.1</span> 2112</div> 2113<ul> 2114<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 2115</ul> 2116<p><strong>Only valid for response obtained from <a href="#http_class_http_clientrequest"><code>http.ClientRequest</code></a>.</strong></p> 2117<p>The 3-digit HTTP response status code. E.G. <code>404</code>.</p> 2118<h4><code>message.statusMessage</code><span><a class="mark" href="#http_message_statusmessage" id="http_message_statusmessage">#</a></span></h4> 2119<div class="api_metadata"> 2120<span>Added in: v0.11.10</span> 2121</div> 2122<ul> 2123<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 2124</ul> 2125<p><strong>Only valid for response obtained from <a href="#http_class_http_clientrequest"><code>http.ClientRequest</code></a>.</strong></p> 2126<p>The HTTP response status message (reason phrase). E.G. <code>OK</code> or <code>Internal Server Error</code>.</p> 2127<h4><code>message.trailers</code><span><a class="mark" href="#http_message_trailers" id="http_message_trailers">#</a></span></h4> 2128<div class="api_metadata"> 2129<span>Added in: v0.3.0</span> 2130</div> 2131<ul> 2132<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 2133</ul> 2134<p>The request/response trailers object. Only populated at the <code>'end'</code> event.</p> 2135<h4><code>message.url</code><span><a class="mark" href="#http_message_url" id="http_message_url">#</a></span></h4> 2136<div class="api_metadata"> 2137<span>Added in: v0.1.90</span> 2138</div> 2139<ul> 2140<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 2141</ul> 2142<p><strong>Only valid for request obtained from <a href="#http_class_http_server"><code>http.Server</code></a>.</strong></p> 2143<p>Request URL string. This contains only the URL that is present in the actual 2144HTTP request. Take the following request:</p> 2145<pre><code class="language-http"><span class="hljs-keyword">GET</span> <span class="hljs-string">/status?name=ryan</span> <span class="hljs-meta">HTTP/1.1</span> 2146<span class="hljs-attribute">Accept</span><span class="hljs-punctuation">: </span>text/plain</code></pre> 2147<p>To parse the URL into its parts:</p> 2148<pre><code class="language-js"><span class="hljs-keyword">new</span> <span class="hljs-title function_">URL</span>(request.<span class="hljs-property">url</span>, <span class="hljs-string">`http://<span class="hljs-subst">${request.headers.host}</span>`</span>);</code></pre> 2149<p>When <code>request.url</code> is <code>'/status?name=ryan'</code> and 2150<code>request.headers.host</code> is <code>'localhost:3000'</code>:</p> 2151<pre><code class="language-console"><span class="hljs-meta">$ </span><span class="language-bash">node</span> 2152<span class="hljs-meta">> </span><span class="language-bash">new URL(request.url, `http://<span class="hljs-variable">${request.headers.host}</span>`)</span> 2153URL { 2154 href: 'http://localhost:3000/status?name=ryan', 2155 origin: 'http://localhost:3000', 2156 protocol: 'http:', 2157 username: '', 2158 password: '', 2159 host: 'localhost:3000', 2160 hostname: 'localhost', 2161 port: '3000', 2162 pathname: '/status', 2163 search: '?name=ryan', 2164 searchParams: URLSearchParams { 'name' => 'ryan' }, 2165 hash: '' 2166}</code></pre> 2167</section><section><h3>Class: <code>http.OutgoingMessage</code><span><a class="mark" href="#http_class_http_outgoingmessage" id="http_class_http_outgoingmessage">#</a></span></h3> 2168<div class="api_metadata"> 2169<span>Added in: v0.1.17</span> 2170</div> 2171<ul> 2172<li>Extends: <a href="stream.html#stream_stream" class="type"><Stream></a></li> 2173</ul> 2174<p>This class serves as the parent class of <a href="#http_class_http_clientrequest"><code>http.ClientRequest</code></a> 2175and <a href="#http_class_http_serverresponse"><code>http.ServerResponse</code></a>. It is an abstract of outgoing message from 2176the perspective of the participants of HTTP transaction.</p> 2177<h4>Event: <code>drain</code><span><a class="mark" href="#http_event_drain" id="http_event_drain">#</a></span></h4> 2178<div class="api_metadata"> 2179<span>Added in: v0.3.6</span> 2180</div> 2181<p>Emitted when the buffer of the message is free again.</p> 2182<h4>Event: <code>finish</code><span><a class="mark" href="#http_event_finish_1" id="http_event_finish_1">#</a></span></h4> 2183<div class="api_metadata"> 2184<span>Added in: v0.1.17</span> 2185</div> 2186<p>Emitted when the transmission is finished successfully.</p> 2187<h4>Event: <code>prefinish</code><span><a class="mark" href="#http_event_prefinish" id="http_event_prefinish">#</a></span></h4> 2188<div class="api_metadata"> 2189<span>Added in: v0.11.6</span> 2190</div> 2191<p>Emitted when <code>outgoingMessage.end</code> was called. 2192When the event is emitted, all data has been processed but not necessarily 2193completely flushed.</p> 2194<h4><code>outgoingMessage.addTrailers(headers)</code><span><a class="mark" href="#http_outgoingmessage_addtrailers_headers" id="http_outgoingmessage_addtrailers_headers">#</a></span></h4> 2195<div class="api_metadata"> 2196<span>Added in: v0.3.0</span> 2197</div> 2198<ul> 2199<li><code>headers</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 2200</ul> 2201<p>Adds HTTP trailers (headers but at the end of the message) to the message.</p> 2202<p>Trailers are <strong>only</strong> be emitted if the message is chunked encoded. If not, 2203the trailer will be silently discarded.</p> 2204<p>HTTP requires the <code>Trailer</code> header to be sent to emit trailers, 2205with a list of header fields in its value, e.g.</p> 2206<pre><code class="language-js">message.<span class="hljs-title function_">writeHead</span>(<span class="hljs-number">200</span>, { <span class="hljs-string">'Content-Type'</span>: <span class="hljs-string">'text/plain'</span>, 2207 <span class="hljs-string">'Trailer'</span>: <span class="hljs-string">'Content-MD5'</span> }); 2208message.<span class="hljs-title function_">write</span>(fileData); 2209message.<span class="hljs-title function_">addTrailers</span>({ <span class="hljs-string">'Content-MD5'</span>: <span class="hljs-string">'7895bf4b8828b55ceaf47747b4bca667'</span> }); 2210message.<span class="hljs-title function_">end</span>();</code></pre> 2211<p>Attempting to set a header field name or value that contains invalid characters 2212will result in a <code>TypeError</code> being thrown.</p> 2213<h4><code>outgoingMessage.connection</code><span><a class="mark" href="#http_outgoingmessage_connection" id="http_outgoingmessage_connection">#</a></span></h4> 2214<div class="api_metadata"> 2215<span>Added in: v0.3.0</span><span>Deprecated since: v14.17.1</span> 2216</div> 2217<p></p><div class="api_stability api_stability_0"><a href="documentation.html#documentation_stability_index">Stability: 0</a> - Deprecated: Use <a href="#http_outgoingmessage_socket"><code>outgoingMessage.socket</code></a> instead.</div><p></p> 2218<p>Aliases of <code>outgoingMessage.socket</code></p> 2219<h4><code>outgoingMessage.cork()</code><span><a class="mark" href="#http_outgoingmessage_cork" id="http_outgoingmessage_cork">#</a></span></h4> 2220<div class="api_metadata"> 2221<span>Added in: v14.0.0</span> 2222</div> 2223<p>See <a href="stream.html#stream_writable_cork"><code>writable.cork()</code></a>.</p> 2224<h4><code>outgoingMessage.destroy([error])</code><span><a class="mark" href="#http_outgoingmessage_destroy_error" id="http_outgoingmessage_destroy_error">#</a></span></h4> 2225<div class="api_metadata"> 2226<span>Added in: v0.3.0</span> 2227</div> 2228<ul> 2229<li><code>error</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" class="type"><Error></a> Optional, an error to emit with <code>error</code> event</li> 2230<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/this" class="type"><this></a></li> 2231</ul> 2232<p>Destroys the message. Once a socket is associated with the message 2233and is connected, that socket will be destroyed as well.</p> 2234<h4><code>outgoingMessage.end(chunk[, encoding][, callback])</code><span><a class="mark" href="#http_outgoingmessage_end_chunk_encoding_callback" id="http_outgoingmessage_end_chunk_encoding_callback">#</a></span></h4> 2235<div class="api_metadata"> 2236<details class="changelog"><summary>History</summary> 2237<table> 2238<tbody><tr><th>Version</th><th>Changes</th></tr> 2239<tr><td>v0.11.6</td> 2240<td><p>add <code>callback</code> argument.</p></td></tr> 2241<tr><td>v0.1.90</td> 2242<td><p><span>Added in: v0.1.90</span></p></td></tr> 2243</tbody></table> 2244</details> 2245</div> 2246<ul> 2247<li><code>chunk</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> | <a href="buffer.html#buffer_class_buffer" class="type"><Buffer></a></li> 2248<li><code>encoding</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> Optional, <strong>Default</strong>: <code>utf-8</code></li> 2249<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> Optional</li> 2250<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/this" class="type"><this></a></li> 2251</ul> 2252<p>Finishes the outgoing message. If any parts of the body are unsent, it will 2253flush them to the underlying system. If the message is chunked, it will 2254send the terminating chunk <code>0\r\n\r\n</code>, and send the trailer (if any).</p> 2255<p>If <code>chunk</code> is specified, it is equivalent to call 2256<code>outgoingMessage.write(chunk, encoding)</code>, followed by 2257<code>outgoingMessage.end(callback)</code>.</p> 2258<p>If <code>callback</code> is provided, it will be called when the message is finished. 2259(equivalent to the callback to event <code>finish</code>)</p> 2260<h4><code>outgoingMessage.flushHeaders()</code><span><a class="mark" href="#http_outgoingmessage_flushheaders" id="http_outgoingmessage_flushheaders">#</a></span></h4> 2261<div class="api_metadata"> 2262<span>Added in: v1.6.0</span> 2263</div> 2264<p>Compulsorily flushes the message headers</p> 2265<p>For efficiency reason, Node.js normally buffers the message headers 2266until <code>outgoingMessage.end()</code> is called or the first chunk of message data 2267is written. It then tries to pack the headers and data into a single TCP 2268packet.</p> 2269<p>It is usually desired (it saves a TCP round-trip), but not when the first 2270data is not sent until possibly much later. <code>outgoingMessage.flushHeaders()</code> 2271bypasses the optimization and kickstarts the request.</p> 2272<h4><code>outgoingMessage.getHeader(name)</code><span><a class="mark" href="#http_outgoingmessage_getheader_name" id="http_outgoingmessage_getheader_name">#</a></span></h4> 2273<div class="api_metadata"> 2274<span>Added in: v0.4.0</span> 2275</div> 2276<ul> 2277<li><code>name</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> Name of header</li> 2278<li>Returns <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Undefined_type" class="type"><undefined></a></li> 2279</ul> 2280<p>Gets the value of HTTP header with the given name. If such a name doesn't 2281exist in message, it will be <code>undefined</code>.</p> 2282<h4><code>outgoingMessage.getHeaderNames()</code><span><a class="mark" href="#http_outgoingmessage_getheadernames" id="http_outgoingmessage_getheadernames">#</a></span></h4> 2283<div class="api_metadata"> 2284<span>Added in: v8.0.0</span> 2285</div> 2286<ul> 2287<li>Returns <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string[]></a></li> 2288</ul> 2289<p>Returns an array of names of headers of the outgoing outgoingMessage. All 2290names are lowercase.</p> 2291<h4><code>outgoingMessage.getHeaders()</code><span><a class="mark" href="#http_outgoingmessage_getheaders" id="http_outgoingmessage_getheaders">#</a></span></h4> 2292<div class="api_metadata"> 2293<span>Added in: v8.0.0</span> 2294</div> 2295<ul> 2296<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 2297</ul> 2298<p>Returns a shallow copy of the current outgoing headers. Since a shallow 2299copy is used, array values may be mutated without additional calls to 2300various header-related HTTP module methods. The keys of the returned 2301object are the header names and the values are the respective header 2302values. All header names are lowercase.</p> 2303<p>The object returned by the <code>outgoingMessage.getHeaders()</code> method does 2304not prototypically inherit from the JavaScript Object. This means that 2305typical Object methods such as <code>obj.toString()</code>, <code>obj.hasOwnProperty()</code>, 2306and others are not defined and will not work.</p> 2307<pre><code class="language-js">outgoingMessage.<span class="hljs-title function_">setHeader</span>(<span class="hljs-string">'Foo'</span>, <span class="hljs-string">'bar'</span>); 2308outgoingMessage.<span class="hljs-title function_">setHeader</span>(<span class="hljs-string">'Set-Cookie'</span>, [<span class="hljs-string">'foo=bar'</span>, <span class="hljs-string">'bar=baz'</span>]); 2309 2310<span class="hljs-keyword">const</span> headers = outgoingMessage.<span class="hljs-title function_">getHeaders</span>(); 2311<span class="hljs-comment">// headers === { foo: 'bar', 'set-cookie': ['foo=bar', 'bar=baz'] }</span></code></pre> 2312<h4><code>outgoingMessage.hasHeader(name)</code><span><a class="mark" href="#http_outgoingmessage_hasheader_name" id="http_outgoingmessage_hasheader_name">#</a></span></h4> 2313<div class="api_metadata"> 2314<span>Added in: v8.0.0</span> 2315</div> 2316<ul> 2317<li><code>name</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 2318<li>Returns <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 2319</ul> 2320<p>Returns <code>true</code> if the header identified by <code>name</code> is currently set in the 2321outgoing headers. The header name is case-insensitive.</p> 2322<pre><code class="language-js"><span class="hljs-keyword">const</span> hasContentType = outgoingMessage.<span class="hljs-title function_">hasHeader</span>(<span class="hljs-string">'content-type'</span>);</code></pre> 2323<h4><code>outgoingMessage.headersSent</code><span><a class="mark" href="#http_outgoingmessage_headerssent" id="http_outgoingmessage_headerssent">#</a></span></h4> 2324<div class="api_metadata"> 2325<span>Added in: v0.9.3</span> 2326</div> 2327<ul> 2328<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 2329</ul> 2330<p>Read-only. <code>true</code> if the headers were sent, otherwise <code>false</code>.</p> 2331<h4><code>outgoingMessage.pipe()</code><span><a class="mark" href="#http_outgoingmessage_pipe" id="http_outgoingmessage_pipe">#</a></span></h4> 2332<div class="api_metadata"> 2333<span>Added in: v9.0.0</span> 2334</div> 2335<p>Overrides the pipe method of legacy <code>Stream</code> which is the parent class of 2336<code>http.outgoingMessage</code>.</p> 2337<p>Since <code>OutgoingMessage</code> should be a write-only stream, 2338call this function will throw an <code>Error</code>. Thus, it disabled the pipe method 2339it inherits from <code>Stream</code>.</p> 2340<p>The User should not call this function directly.</p> 2341<h4><code>outgoingMessage.removeHeader()</code><span><a class="mark" href="#http_outgoingmessage_removeheader" id="http_outgoingmessage_removeheader">#</a></span></h4> 2342<div class="api_metadata"> 2343<span>Added in: v0.4.0</span> 2344</div> 2345<p>Removes a header that is queued for implicit sending.</p> 2346<pre><code class="language-js">outgoingMessage.<span class="hljs-title function_">removeHeader</span>(<span class="hljs-string">'Content-Encoding'</span>);</code></pre> 2347<h4><code>outgoingMessage.setHeader(name, value)</code><span><a class="mark" href="#http_outgoingmessage_setheader_name_value" id="http_outgoingmessage_setheader_name_value">#</a></span></h4> 2348<div class="api_metadata"> 2349<span>Added in: v0.4.0</span> 2350</div> 2351<ul> 2352<li><code>name</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> Header name</li> 2353<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> Header value</li> 2354<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/this" class="type"><this></a></li> 2355</ul> 2356<p>Sets a single header value for the header object.</p> 2357<h4><code>outgoingMessage.setTimeout(msesc[, callback])</code><span><a class="mark" href="#http_outgoingmessage_settimeout_msesc_callback" id="http_outgoingmessage_settimeout_msesc_callback">#</a></span></h4> 2358<div class="api_metadata"> 2359<span>Added in: v0.9.12</span> 2360</div> 2361<ul> 2362<li><code>msesc</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 2363<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> Optional function to be called when a timeout</li> 2364</ul> 2365<p>occurs, Same as binding to the <code>timeout</code> event.</p> 2366<ul> 2367<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/this" class="type"><this></a></li> 2368</ul> 2369<p>Once a socket is associated with the message and is connected, 2370<a href="net.html#net_socket_settimeout_timeout_callback"><code>socket.setTimeout()</code></a> will be called with <code>msecs</code> as the first parameter.</p> 2371<h4><code>outgoingMessage.socket</code><span><a class="mark" href="#http_outgoingmessage_socket" id="http_outgoingmessage_socket">#</a></span></h4> 2372<div class="api_metadata"> 2373<span>Added in: v0.3.0</span> 2374</div> 2375<ul> 2376<li><a href="stream.html#stream_class_stream_duplex" class="type"><stream.Duplex></a></li> 2377</ul> 2378<p>Reference to the underlying socket. Usually, users will not want to access 2379this property.</p> 2380<p>After calling <code>outgoingMessage.end()</code>, this property will be nulled.</p> 2381<h4><code>outgoingMessage.uncork()</code><span><a class="mark" href="#http_outgoingmessage_uncork" id="http_outgoingmessage_uncork">#</a></span></h4> 2382<div class="api_metadata"> 2383<span>Added in: v14.0.0</span> 2384</div> 2385<p>See <a href="stream.html#stream_writable_uncork"><code>writable.uncork()</code></a></p> 2386<h4><code>outgoingMessage.writableCorked</code><span><a class="mark" href="#http_outgoingmessage_writablecorked" id="http_outgoingmessage_writablecorked">#</a></span></h4> 2387<div class="api_metadata"> 2388<span>Added in: v14.0.0</span> 2389</div> 2390<ul> 2391<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 2392</ul> 2393<p>This <code>outgoingMessage.writableCorked</code> will return the time how many 2394<code>outgoingMessage.cork()</code> have been called.</p> 2395<h4><code>outgoingMessage.writableEnded</code><span><a class="mark" href="#http_outgoingmessage_writableended" id="http_outgoingmessage_writableended">#</a></span></h4> 2396<div class="api_metadata"> 2397<span>Added in: v13.0.0</span> 2398</div> 2399<ul> 2400<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 2401</ul> 2402<p>Readonly, <code>true</code> if <code>outgoingMessage.end()</code> has been called. Noted that 2403this property does not reflect whether the data has been flush. For that 2404purpose, use <code>message.writableFinished</code> instead.</p> 2405<h4><code>outgoingMessage.writableFinished</code><span><a class="mark" href="#http_outgoingmessage_writablefinished" id="http_outgoingmessage_writablefinished">#</a></span></h4> 2406<div class="api_metadata"> 2407<span>Added in: v13.0.0</span> 2408</div> 2409<ul> 2410<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 2411</ul> 2412<p>Readonly. <code>true</code> if all data has been flushed to the underlying system.</p> 2413<h4><code>outgoingMessage.writableHighWaterMark</code><span><a class="mark" href="#http_outgoingmessage_writablehighwatermark" id="http_outgoingmessage_writablehighwatermark">#</a></span></h4> 2414<div class="api_metadata"> 2415<span>Added in: v13.0.0</span> 2416</div> 2417<ul> 2418<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 2419</ul> 2420<p>This <code>outgoingMessage.writableHighWaterMark</code> will be the <code>highWaterMark</code> of 2421underlying socket if socket exists. Else, it would be the default 2422<code>highWaterMark</code>.</p> 2423<p><code>highWaterMark</code> is the maximum amount of data that can be potentially 2424buffered by the socket.</p> 2425<h4><code>outgoingMessage.writableLength</code><span><a class="mark" href="#http_outgoingmessage_writablelength" id="http_outgoingmessage_writablelength">#</a></span></h4> 2426<div class="api_metadata"> 2427<span>Added in: v13.0.0</span> 2428</div> 2429<ul> 2430<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 2431</ul> 2432<p>Readonly, This <code>outgoingMessage.writableLength</code> contains the number of 2433bytes (or objects) in the buffer ready to send.</p> 2434<h4><code>outgoingMessage.writableObjectMode</code><span><a class="mark" href="#http_outgoingmessage_writableobjectmode" id="http_outgoingmessage_writableobjectmode">#</a></span></h4> 2435<div class="api_metadata"> 2436<span>Added in: v13.0.0</span> 2437</div> 2438<ul> 2439<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 2440</ul> 2441<p>Readonly, always returns <code>false</code>.</p> 2442<h4><code>outgoingMessage.write(chunk[, encoding][, callback])</code><span><a class="mark" href="#http_outgoingmessage_write_chunk_encoding_callback" id="http_outgoingmessage_write_chunk_encoding_callback">#</a></span></h4> 2443<div class="api_metadata"> 2444<details class="changelog"><summary>History</summary> 2445<table> 2446<tbody><tr><th>Version</th><th>Changes</th></tr> 2447<tr><td>v0.11.6</td> 2448<td><p>add <code>callback</code> argument.</p></td></tr> 2449<tr><td>v0.1.29</td> 2450<td><p><span>Added in: v0.1.29</span></p></td></tr> 2451</tbody></table> 2452</details> 2453</div> 2454<ul> 2455<li><code>chunk</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> | <a href="buffer.html#buffer_class_buffer" class="type"><Buffer></a></li> 2456<li><code>encoding</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> <strong>Default</strong>: <code>utf-8</code></li> 2457<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 2458<li>Returns <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 2459</ul> 2460<p>If this method is called and the header is not sent, it will call 2461<code>this._implicitHeader</code> to flush implicit header. 2462If the message should not have a body (indicated by <code>this._hasBody</code>), 2463the call is ignored and <code>chunk</code> will not be sent. It could be useful 2464when handling a particular message which must not include a body. 2465e.g. response to <code>HEAD</code> request, <code>204</code> and <code>304</code> response.</p> 2466<p><code>chunk</code> can be a string or a buffer. When <code>chunk</code> is a string, the 2467<code>encoding</code> parameter specifies how to encode <code>chunk</code> into a byte stream. 2468<code>callback</code> will be called when the <code>chunk</code> is flushed.</p> 2469<p>If the message is transferred in chucked encoding 2470(indicated by <code>this.chunkedEncoding</code>), <code>chunk</code> will be flushed as 2471one chunk among a stream of chunks. Otherwise, it will be flushed as the 2472body of message.</p> 2473<p>This method handles the raw body of the HTTP message and has nothing to do 2474with higher-level multi-part body encodings that may be used.</p> 2475<p>If it is the first call to this method of a message, it will send the 2476buffered header first, then flush the <code>chunk</code> as described above.</p> 2477<p>The second and successive calls to this method will assume the data 2478will be streamed and send the new data separately. It means that the response 2479is buffered up to the first chunk of the body.</p> 2480<p>Returns <code>true</code> if the entire data was flushed successfully to the kernel 2481buffer. Returns <code>false</code> if all or part of the data was queued in the user 2482memory. Event <code>drain</code> will be emitted when the buffer is free again.</p> 2483</section><section><h3><code>http.METHODS</code><span><a class="mark" href="#http_http_methods" id="http_http_methods">#</a></span></h3> 2484<div class="api_metadata"> 2485<span>Added in: v0.11.8</span> 2486</div> 2487<ul> 2488<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string[]></a></li> 2489</ul> 2490<p>A list of the HTTP methods that are supported by the parser.</p> 2491</section><section><h3><code>http.STATUS_CODES</code><span><a class="mark" href="#http_http_status_codes" id="http_http_status_codes">#</a></span></h3> 2492<div class="api_metadata"> 2493<span>Added in: v0.1.22</span> 2494</div> 2495<ul> 2496<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 2497</ul> 2498<p>A collection of all the standard HTTP response status codes, and the 2499short description of each. For example, <code>http.STATUS_CODES[404] === 'Not Found'</code>.</p> 2500</section><section><h3><code>http.createServer([options][, requestListener])</code><span><a class="mark" href="#http_http_createserver_options_requestlistener" id="http_http_createserver_options_requestlistener">#</a></span></h3> 2501<div class="api_metadata"> 2502<details class="changelog"><summary>History</summary> 2503<table> 2504<tbody><tr><th>Version</th><th>Changes</th></tr> 2505<tr><td>v13.3.0</td> 2506<td><p>The <code>maxHeaderSize</code> option is supported now.</p></td></tr> 2507<tr><td>v13.8.0, v12.15.0, v10.19.0</td> 2508<td><p>The <code>insecureHTTPParser</code> option is supported now.</p></td></tr> 2509<tr><td>v9.6.0, v8.12.0</td> 2510<td><p>The <code>options</code> argument is supported now.</p></td></tr> 2511<tr><td>v0.1.13</td> 2512<td><p><span>Added in: v0.1.13</span></p></td></tr> 2513</tbody></table> 2514</details> 2515</div> 2516<ul> 2517<li> 2518<p><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></p> 2519<ul> 2520<li><code>IncomingMessage</code> <a href="http.html#http_class_http_incomingmessage" class="type"><http.IncomingMessage></a> Specifies the <code>IncomingMessage</code> 2521class to be used. Useful for extending the original <code>IncomingMessage</code>. 2522<strong>Default:</strong> <code>IncomingMessage</code>.</li> 2523<li><code>ServerResponse</code> <a href="http.html#http_class_http_serverresponse" class="type"><http.ServerResponse></a> Specifies the <code>ServerResponse</code> class 2524to be used. Useful for extending the original <code>ServerResponse</code>. <strong>Default:</strong> 2525<code>ServerResponse</code>.</li> 2526<li><code>insecureHTTPParser</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> Use an insecure HTTP parser that accepts 2527invalid HTTP headers when <code>true</code>. Using the insecure parser should be 2528avoided. See <a href="cli.html#cli_insecure_http_parser"><code>--insecure-http-parser</code></a> for more information. 2529<strong>Default:</strong> <code>false</code></li> 2530<li><code>maxHeaderSize</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Optionally overrides the value of 2531<a href="cli.html#cli_max_http_header_size_size"><code>--max-http-header-size</code></a> for requests received by this server, i.e. 2532the maximum length of request headers in bytes. 2533<strong>Default:</strong> 16384 (16KB).</li> 2534</ul> 2535</li> 2536<li> 2537<p><code>requestListener</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></p> 2538</li> 2539<li> 2540<p>Returns: <a href="http.html#http_class_http_server" class="type"><http.Server></a></p> 2541</li> 2542</ul> 2543<p>Returns a new instance of <a href="#http_class_http_server"><code>http.Server</code></a>.</p> 2544<p>The <code>requestListener</code> is a function which is automatically 2545added to the <a href="#http_event_request"><code>'request'</code></a> event.</p> 2546 2547<pre><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><pre><code class="language-js cjs"><span class="hljs-keyword">const</span> http = <span class="hljs-built_in">require</span>(<span class="hljs-string">'http'</span>); 2548 2549<span class="hljs-comment">// Create a local server to receive data from</span> 2550<span class="hljs-keyword">const</span> server = http.<span class="hljs-title function_">createServer</span>(<span class="hljs-function">(<span class="hljs-params">req, res</span>) =></span> { 2551 res.<span class="hljs-title function_">writeHead</span>(<span class="hljs-number">200</span>, { <span class="hljs-string">'Content-Type'</span>: <span class="hljs-string">'application/json'</span> }); 2552 res.<span class="hljs-title function_">end</span>(<span class="hljs-variable constant_">JSON</span>.<span class="hljs-title function_">stringify</span>({ 2553 <span class="hljs-attr">data</span>: <span class="hljs-string">'Hello World!'</span> 2554 })); 2555}); 2556 2557server.<span class="hljs-title function_">listen</span>(<span class="hljs-number">8000</span>);</code></pre><code class="language-js cjs"><span class="hljs-keyword">const</span> http = <span class="hljs-built_in">require</span>(<span class="hljs-string">'http'</span>); 2558 2559<span class="hljs-comment">// Create a local server to receive data from</span> 2560<span class="hljs-keyword">const</span> server = http.<span class="hljs-title function_">createServer</span>(); 2561 2562<span class="hljs-comment">// Listen to the request event</span> 2563server.<span class="hljs-title function_">on</span>(<span class="hljs-string">'request'</span>, <span class="hljs-function">(<span class="hljs-params">request, res</span>) =></span> { 2564 res.<span class="hljs-title function_">writeHead</span>(<span class="hljs-number">200</span>, { <span class="hljs-string">'Content-Type'</span>: <span class="hljs-string">'application/json'</span> }); 2565 res.<span class="hljs-title function_">end</span>(<span class="hljs-variable constant_">JSON</span>.<span class="hljs-title function_">stringify</span>({ 2566 <span class="hljs-attr">data</span>: <span class="hljs-string">'Hello World!'</span> 2567 })); 2568}); 2569 2570server.<span class="hljs-title function_">listen</span>(<span class="hljs-number">8000</span>);</code></pre> 2571</section><section><h3><code>http.get(options[, callback])</code><span><a class="mark" href="#http_http_get_options_callback" id="http_http_get_options_callback">#</a></span></h3> 2572</section><section><h3><code>http.get(url[, options][, callback])</code><span><a class="mark" href="#http_http_get_url_options_callback" id="http_http_get_url_options_callback">#</a></span></h3> 2573<div class="api_metadata"> 2574<details class="changelog"><summary>History</summary> 2575<table> 2576<tbody><tr><th>Version</th><th>Changes</th></tr> 2577<tr><td>v10.9.0</td> 2578<td><p>The <code>url</code> parameter can now be passed along with a separate <code>options</code> object.</p></td></tr> 2579<tr><td>v7.5.0</td> 2580<td><p>The <code>options</code> parameter can be a WHATWG <code>URL</code> object.</p></td></tr> 2581<tr><td>v0.3.6</td> 2582<td><p><span>Added in: v0.3.6</span></p></td></tr> 2583</tbody></table> 2584</details> 2585</div> 2586<ul> 2587<li><code>url</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> | <a href="url.html#url_the_whatwg_url_api" class="type"><URL></a></li> 2588<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> Accepts the same <code>options</code> as 2589<a href="#http_http_request_options_callback"><code>http.request()</code></a>, with the <code>method</code> always set to <code>GET</code>. 2590Properties that are inherited from the prototype are ignored.</li> 2591<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 2592<li>Returns: <a href="http.html#http_class_http_clientrequest" class="type"><http.ClientRequest></a></li> 2593</ul> 2594<p>Since most requests are GET requests without bodies, Node.js provides this 2595convenience method. The only difference between this method and 2596<a href="#http_http_request_options_callback"><code>http.request()</code></a> is that it sets the method to GET and calls <code>req.end()</code> 2597automatically. The callback must take care to consume the response 2598data for reasons stated in <a href="#http_class_http_clientrequest"><code>http.ClientRequest</code></a> section.</p> 2599<p>The <code>callback</code> is invoked with a single argument that is an instance of 2600<a href="#http_class_http_incomingmessage"><code>http.IncomingMessage</code></a>.</p> 2601<p>JSON fetching example:</p> 2602<pre><code class="language-js">http.<span class="hljs-title function_">get</span>(<span class="hljs-string">'http://localhost:8000/'</span>, <span class="hljs-function">(<span class="hljs-params">res</span>) =></span> { 2603 <span class="hljs-keyword">const</span> { statusCode } = res; 2604 <span class="hljs-keyword">const</span> contentType = res.<span class="hljs-property">headers</span>[<span class="hljs-string">'content-type'</span>]; 2605 2606 <span class="hljs-keyword">let</span> error; 2607 <span class="hljs-comment">// Any 2xx status code signals a successful response but</span> 2608 <span class="hljs-comment">// here we're only checking for 200.</span> 2609 <span class="hljs-keyword">if</span> (statusCode !== <span class="hljs-number">200</span>) { 2610 error = <span class="hljs-keyword">new</span> <span class="hljs-title class_">Error</span>(<span class="hljs-string">'Request Failed.\n'</span> + 2611 <span class="hljs-string">`Status Code: <span class="hljs-subst">${statusCode}</span>`</span>); 2612 } <span class="hljs-keyword">else</span> <span class="hljs-keyword">if</span> (!<span class="hljs-regexp">/^application\/json/</span>.<span class="hljs-title function_">test</span>(contentType)) { 2613 error = <span class="hljs-keyword">new</span> <span class="hljs-title class_">Error</span>(<span class="hljs-string">'Invalid content-type.\n'</span> + 2614 <span class="hljs-string">`Expected application/json but received <span class="hljs-subst">${contentType}</span>`</span>); 2615 } 2616 <span class="hljs-keyword">if</span> (error) { 2617 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">error</span>(error.<span class="hljs-property">message</span>); 2618 <span class="hljs-comment">// Consume response data to free up memory</span> 2619 res.<span class="hljs-title function_">resume</span>(); 2620 <span class="hljs-keyword">return</span>; 2621 } 2622 2623 res.<span class="hljs-title function_">setEncoding</span>(<span class="hljs-string">'utf8'</span>); 2624 <span class="hljs-keyword">let</span> rawData = <span class="hljs-string">''</span>; 2625 res.<span class="hljs-title function_">on</span>(<span class="hljs-string">'data'</span>, <span class="hljs-function">(<span class="hljs-params">chunk</span>) =></span> { rawData += chunk; }); 2626 res.<span class="hljs-title function_">on</span>(<span class="hljs-string">'end'</span>, <span class="hljs-function">() =></span> { 2627 <span class="hljs-keyword">try</span> { 2628 <span class="hljs-keyword">const</span> parsedData = <span class="hljs-variable constant_">JSON</span>.<span class="hljs-title function_">parse</span>(rawData); 2629 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(parsedData); 2630 } <span class="hljs-keyword">catch</span> (e) { 2631 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">error</span>(e.<span class="hljs-property">message</span>); 2632 } 2633 }); 2634}).<span class="hljs-title function_">on</span>(<span class="hljs-string">'error'</span>, <span class="hljs-function">(<span class="hljs-params">e</span>) =></span> { 2635 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">error</span>(<span class="hljs-string">`Got error: <span class="hljs-subst">${e.message}</span>`</span>); 2636}); 2637 2638<span class="hljs-comment">// Create a local server to receive data from</span> 2639<span class="hljs-keyword">const</span> server = http.<span class="hljs-title function_">createServer</span>(<span class="hljs-function">(<span class="hljs-params">req, res</span>) =></span> { 2640 res.<span class="hljs-title function_">writeHead</span>(<span class="hljs-number">200</span>, { <span class="hljs-string">'Content-Type'</span>: <span class="hljs-string">'application/json'</span> }); 2641 res.<span class="hljs-title function_">end</span>(<span class="hljs-variable constant_">JSON</span>.<span class="hljs-title function_">stringify</span>({ 2642 <span class="hljs-attr">data</span>: <span class="hljs-string">'Hello World!'</span> 2643 })); 2644}); 2645 2646server.<span class="hljs-title function_">listen</span>(<span class="hljs-number">8000</span>);</code></pre> 2647</section><section><h3><code>http.globalAgent</code><span><a class="mark" href="#http_http_globalagent" id="http_http_globalagent">#</a></span></h3> 2648<div class="api_metadata"> 2649<span>Added in: v0.5.9</span> 2650</div> 2651<ul> 2652<li><a href="http.html#http_class_http_agent" class="type"><http.Agent></a></li> 2653</ul> 2654<p>Global instance of <code>Agent</code> which is used as the default for all HTTP client 2655requests.</p> 2656</section><section><h3><code>http.maxHeaderSize</code><span><a class="mark" href="#http_http_maxheadersize" id="http_http_maxheadersize">#</a></span></h3> 2657<div class="api_metadata"> 2658<span>Added in: v11.6.0, v10.15.0</span> 2659</div> 2660<ul> 2661<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 2662</ul> 2663<p>Read-only property specifying the maximum allowed size of HTTP headers in bytes. 2664Defaults to 8KB. Configurable using the <a href="cli.html#cli_max_http_header_size_size"><code>--max-http-header-size</code></a> CLI option.</p> 2665<p>This can be overridden for servers and client requests by passing the 2666<code>maxHeaderSize</code> option.</p> 2667</section><section><h3><code>http.request(options[, callback])</code><span><a class="mark" href="#http_http_request_options_callback" id="http_http_request_options_callback">#</a></span></h3> 2668</section><section><h3><code>http.request(url[, options][, callback])</code><span><a class="mark" href="#http_http_request_url_options_callback" id="http_http_request_url_options_callback">#</a></span></h3> 2669<div class="api_metadata"> 2670<details class="changelog"><summary>History</summary> 2671<table> 2672<tbody><tr><th>Version</th><th>Changes</th></tr> 2673<tr><td>v14.18.0</td> 2674<td><p>When using a <code>URL</code> object parsed username and password will now be properly URI decoded.</p></td></tr> 2675<tr><td>v14.17.0</td> 2676<td><p>It is possible to abort a request with an AbortSignal.</p></td></tr> 2677<tr><td>v13.3.0</td> 2678<td><p>The <code>maxHeaderSize</code> option is supported now.</p></td></tr> 2679<tr><td>v13.8.0, v12.15.0, v10.19.0</td> 2680<td><p>The <code>insecureHTTPParser</code> option is supported now.</p></td></tr> 2681<tr><td>v10.9.0</td> 2682<td><p>The <code>url</code> parameter can now be passed along with a separate <code>options</code> object.</p></td></tr> 2683<tr><td>v7.5.0</td> 2684<td><p>The <code>options</code> parameter can be a WHATWG <code>URL</code> object.</p></td></tr> 2685<tr><td>v0.3.6</td> 2686<td><p><span>Added in: v0.3.6</span></p></td></tr> 2687</tbody></table> 2688</details> 2689</div> 2690<ul> 2691<li><code>url</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> | <a href="url.html#url_the_whatwg_url_api" class="type"><URL></a></li> 2692<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 2693<ul> 2694<li><code>agent</code> <a href="http.html#http_class_http_agent" class="type"><http.Agent></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> Controls <a href="#http_class_http_agent"><code>Agent</code></a> behavior. Possible 2695values: 2696<ul> 2697<li><code>undefined</code> (default): use <a href="#http_http_globalagent"><code>http.globalAgent</code></a> for this host and port.</li> 2698<li><code>Agent</code> object: explicitly use the passed in <code>Agent</code>.</li> 2699<li><code>false</code>: causes a new <code>Agent</code> with default values to be used.</li> 2700</ul> 2701</li> 2702<li><code>auth</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> Basic authentication i.e. <code>'user:password'</code> to compute an 2703Authorization header.</li> 2704<li><code>createConnection</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> A function that produces a socket/stream to 2705use for the request when the <code>agent</code> option is not used. This can be used to 2706avoid creating a custom <code>Agent</code> class just to override the default 2707<code>createConnection</code> function. See <a href="#http_agent_createconnection_options_callback"><code>agent.createConnection()</code></a> for more 2708details. Any <a href="stream.html#stream_class_stream_duplex"><code>Duplex</code></a> stream is a valid return value.</li> 2709<li><code>defaultPort</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Default port for the protocol. <strong>Default:</strong> 2710<code>agent.defaultPort</code> if an <code>Agent</code> is used, else <code>undefined</code>.</li> 2711<li><code>family</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> IP address family to use when resolving <code>host</code> or 2712<code>hostname</code>. Valid values are <code>4</code> or <code>6</code>. When unspecified, both IP v4 and 2713v6 will be used.</li> 2714<li><code>headers</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> An object containing request headers.</li> 2715<li><code>hints</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Optional <a href="dns.html#dns_supported_getaddrinfo_flags"><code>dns.lookup()</code> hints</a>.</li> 2716<li><code>host</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> A domain name or IP address of the server to issue the 2717request to. <strong>Default:</strong> <code>'localhost'</code>.</li> 2718<li><code>hostname</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> Alias for <code>host</code>. To support <a href="url.html#url_url_parse_urlstring_parsequerystring_slashesdenotehost"><code>url.parse()</code></a>, 2719<code>hostname</code> will be used if both <code>host</code> and <code>hostname</code> are specified.</li> 2720<li><code>insecureHTTPParser</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> Use an insecure HTTP parser that accepts 2721invalid HTTP headers when <code>true</code>. Using the insecure parser should be 2722avoided. See <a href="cli.html#cli_insecure_http_parser"><code>--insecure-http-parser</code></a> for more information. 2723<strong>Default:</strong> <code>false</code></li> 2724<li><code>localAddress</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> Local interface to bind for network connections.</li> 2725<li><code>localPort</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Local port to connect from.</li> 2726<li><code>lookup</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> Custom lookup function. <strong>Default:</strong> <a href="dns.html#dns_dns_lookup_hostname_options_callback"><code>dns.lookup()</code></a>.</li> 2727<li><code>maxHeaderSize</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Optionally overrides the value of 2728<a href="cli.html#cli_max_http_header_size_size"><code>--max-http-header-size</code></a> for requests received from the server, i.e. 2729the maximum length of response headers in bytes. 2730<strong>Default:</strong> 16384 (16KB).</li> 2731<li><code>method</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> A string specifying the HTTP request method. <strong>Default:</strong> 2732<code>'GET'</code>.</li> 2733<li><code>path</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> Request path. Should include query string if any. 2734E.G. <code>'/index.html?page=12'</code>. An exception is thrown when the request path 2735contains illegal characters. Currently, only spaces are rejected but that 2736may change in the future. <strong>Default:</strong> <code>'/'</code>.</li> 2737<li><code>port</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Port of remote server. <strong>Default:</strong> <code>defaultPort</code> if set, 2738else <code>80</code>.</li> 2739<li><code>protocol</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> Protocol to use. <strong>Default:</strong> <code>'http:'</code>.</li> 2740<li><code>setHost</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a>: Specifies whether or not to automatically add the 2741<code>Host</code> header. Defaults to <code>true</code>.</li> 2742<li><code>socketPath</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> Unix Domain Socket (cannot be used if one of <code>host</code> 2743or <code>port</code> is specified, those specify a TCP Socket).</li> 2744<li><code>timeout</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a>: A number specifying the socket timeout in milliseconds. 2745This will set the timeout before the socket is connected.</li> 2746<li><code>signal</code> <a href="globals.html#globals_class_abortsignal" class="type"><AbortSignal></a>: An AbortSignal that may be used to abort an ongoing 2747request.</li> 2748</ul> 2749</li> 2750<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 2751<li>Returns: <a href="http.html#http_class_http_clientrequest" class="type"><http.ClientRequest></a></li> 2752</ul> 2753<p>Node.js maintains several connections per server to make HTTP requests. 2754This function allows one to transparently issue requests.</p> 2755<p><code>url</code> can be a string or a <a href="url.html#url_the_whatwg_url_api"><code>URL</code></a> object. If <code>url</code> is a 2756string, it is automatically parsed with <a href="url.html#url_new_url_input_base"><code>new URL()</code></a>. If it is a <a href="url.html#url_the_whatwg_url_api"><code>URL</code></a> 2757object, it will be automatically converted to an ordinary <code>options</code> object.</p> 2758<p>If both <code>url</code> and <code>options</code> are specified, the objects are merged, with the 2759<code>options</code> properties taking precedence.</p> 2760<p>The optional <code>callback</code> parameter will be added as a one-time listener for 2761the <a href="#http_event_response"><code>'response'</code></a> event.</p> 2762<p><code>http.request()</code> returns an instance of the <a href="#http_class_http_clientrequest"><code>http.ClientRequest</code></a> 2763class. The <code>ClientRequest</code> instance is a writable stream. If one needs to 2764upload a file with a POST request, then write to the <code>ClientRequest</code> object.</p> 2765<pre><code class="language-js"><span class="hljs-keyword">const</span> http = <span class="hljs-built_in">require</span>(<span class="hljs-string">'http'</span>); 2766 2767<span class="hljs-keyword">const</span> postData = <span class="hljs-variable constant_">JSON</span>.<span class="hljs-title function_">stringify</span>({ 2768 <span class="hljs-string">'msg'</span>: <span class="hljs-string">'Hello World!'</span> 2769}); 2770 2771<span class="hljs-keyword">const</span> options = { 2772 <span class="hljs-attr">hostname</span>: <span class="hljs-string">'www.google.com'</span>, 2773 <span class="hljs-attr">port</span>: <span class="hljs-number">80</span>, 2774 <span class="hljs-attr">path</span>: <span class="hljs-string">'/upload'</span>, 2775 <span class="hljs-attr">method</span>: <span class="hljs-string">'POST'</span>, 2776 <span class="hljs-attr">headers</span>: { 2777 <span class="hljs-string">'Content-Type'</span>: <span class="hljs-string">'application/json'</span>, 2778 <span class="hljs-string">'Content-Length'</span>: <span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">byteLength</span>(postData) 2779 } 2780}; 2781 2782<span class="hljs-keyword">const</span> req = http.<span class="hljs-title function_">request</span>(options, <span class="hljs-function">(<span class="hljs-params">res</span>) =></span> { 2783 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">`STATUS: <span class="hljs-subst">${res.statusCode}</span>`</span>); 2784 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">`HEADERS: <span class="hljs-subst">${<span class="hljs-built_in">JSON</span>.stringify(res.headers)}</span>`</span>); 2785 res.<span class="hljs-title function_">setEncoding</span>(<span class="hljs-string">'utf8'</span>); 2786 res.<span class="hljs-title function_">on</span>(<span class="hljs-string">'data'</span>, <span class="hljs-function">(<span class="hljs-params">chunk</span>) =></span> { 2787 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">`BODY: <span class="hljs-subst">${chunk}</span>`</span>); 2788 }); 2789 res.<span class="hljs-title function_">on</span>(<span class="hljs-string">'end'</span>, <span class="hljs-function">() =></span> { 2790 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">'No more data in response.'</span>); 2791 }); 2792}); 2793 2794req.<span class="hljs-title function_">on</span>(<span class="hljs-string">'error'</span>, <span class="hljs-function">(<span class="hljs-params">e</span>) =></span> { 2795 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">error</span>(<span class="hljs-string">`problem with request: <span class="hljs-subst">${e.message}</span>`</span>); 2796}); 2797 2798<span class="hljs-comment">// Write data to request body</span> 2799req.<span class="hljs-title function_">write</span>(postData); 2800req.<span class="hljs-title function_">end</span>();</code></pre> 2801<p>In the example <code>req.end()</code> was called. With <code>http.request()</code> one 2802must always call <code>req.end()</code> to signify the end of the request - 2803even if there is no data being written to the request body.</p> 2804<p>If any error is encountered during the request (be that with DNS resolution, 2805TCP level errors, or actual HTTP parse errors) an <code>'error'</code> event is emitted 2806on the returned request object. As with all <code>'error'</code> events, if no listeners 2807are registered the error will be thrown.</p> 2808<p>There are a few special headers that should be noted.</p> 2809<ul> 2810<li> 2811<p>Sending a 'Connection: keep-alive' will notify Node.js that the connection to 2812the server should be persisted until the next request.</p> 2813</li> 2814<li> 2815<p>Sending a 'Content-Length' header will disable the default chunked encoding.</p> 2816</li> 2817<li> 2818<p>Sending an 'Expect' header will immediately send the request headers. 2819Usually, when sending 'Expect: 100-continue', both a timeout and a listener 2820for the <code>'continue'</code> event should be set. See RFC 2616 Section 8.2.3 for more 2821information.</p> 2822</li> 2823<li> 2824<p>Sending an Authorization header will override using the <code>auth</code> option 2825to compute basic authentication.</p> 2826</li> 2827</ul> 2828<p>Example using a <a href="url.html#url_the_whatwg_url_api"><code>URL</code></a> as <code>options</code>:</p> 2829<pre><code class="language-js"><span class="hljs-keyword">const</span> options = <span class="hljs-keyword">new</span> <span class="hljs-title function_">URL</span>(<span class="hljs-string">'http://abc:xyz@example.com'</span>); 2830 2831<span class="hljs-keyword">const</span> req = http.<span class="hljs-title function_">request</span>(options, <span class="hljs-function">(<span class="hljs-params">res</span>) =></span> { 2832 <span class="hljs-comment">// ...</span> 2833});</code></pre> 2834<p>In a successful request, the following events will be emitted in the following 2835order:</p> 2836<ul> 2837<li><code>'socket'</code></li> 2838<li><code>'response'</code> 2839<ul> 2840<li><code>'data'</code> any number of times, on the <code>res</code> object 2841(<code>'data'</code> will not be emitted at all if the response body is empty, for 2842instance, in most redirects)</li> 2843<li><code>'end'</code> on the <code>res</code> object</li> 2844</ul> 2845</li> 2846<li><code>'close'</code></li> 2847</ul> 2848<p>In the case of a connection error, the following events will be emitted:</p> 2849<ul> 2850<li><code>'socket'</code></li> 2851<li><code>'error'</code></li> 2852<li><code>'close'</code></li> 2853</ul> 2854<p>In the case of a premature connection close before the response is received, 2855the following events will be emitted in the following order:</p> 2856<ul> 2857<li><code>'socket'</code></li> 2858<li><code>'error'</code> with an error with message <code>'Error: socket hang up'</code> and code 2859<code>'ECONNRESET'</code></li> 2860<li><code>'close'</code></li> 2861</ul> 2862<p>In the case of a premature connection close after the response is received, 2863the following events will be emitted in the following order:</p> 2864<ul> 2865<li><code>'socket'</code></li> 2866<li><code>'response'</code> 2867<ul> 2868<li><code>'data'</code> any number of times, on the <code>res</code> object</li> 2869</ul> 2870</li> 2871<li>(connection closed here)</li> 2872<li><code>'aborted'</code> on the <code>res</code> object</li> 2873<li><code>'close'</code></li> 2874<li><code>'close'</code> on the <code>res</code> object</li> 2875</ul> 2876<p>If <code>req.destroy()</code> is called before a socket is assigned, the following 2877events will be emitted in the following order:</p> 2878<ul> 2879<li>(<code>req.destroy()</code> called here)</li> 2880<li><code>'error'</code> with an error with message <code>'Error: socket hang up'</code> and code 2881<code>'ECONNRESET'</code></li> 2882<li><code>'close'</code></li> 2883</ul> 2884<p>If <code>req.destroy()</code> is called before the connection succeeds, the following 2885events will be emitted in the following order:</p> 2886<ul> 2887<li><code>'socket'</code></li> 2888<li>(<code>req.destroy()</code> called here)</li> 2889<li><code>'error'</code> with an error with message <code>'Error: socket hang up'</code> and code 2890<code>'ECONNRESET'</code></li> 2891<li><code>'close'</code></li> 2892</ul> 2893<p>If <code>req.destroy()</code> is called after the response is received, the following 2894events will be emitted in the following order:</p> 2895<ul> 2896<li><code>'socket'</code></li> 2897<li><code>'response'</code> 2898<ul> 2899<li><code>'data'</code> any number of times, on the <code>res</code> object</li> 2900</ul> 2901</li> 2902<li>(<code>req.destroy()</code> called here)</li> 2903<li><code>'aborted'</code> on the <code>res</code> object</li> 2904<li><code>'close'</code></li> 2905<li><code>'close'</code> on the <code>res</code> object</li> 2906</ul> 2907<p>If <code>req.abort()</code> is called before a socket is assigned, the following 2908events will be emitted in the following order:</p> 2909<ul> 2910<li>(<code>req.abort()</code> called here)</li> 2911<li><code>'abort'</code></li> 2912<li><code>'close'</code></li> 2913</ul> 2914<p>If <code>req.abort()</code> is called before the connection succeeds, the following 2915events will be emitted in the following order:</p> 2916<ul> 2917<li><code>'socket'</code></li> 2918<li>(<code>req.abort()</code> called here)</li> 2919<li><code>'abort'</code></li> 2920<li><code>'error'</code> with an error with message <code>'Error: socket hang up'</code> and code 2921<code>'ECONNRESET'</code></li> 2922<li><code>'close'</code></li> 2923</ul> 2924<p>If <code>req.abort()</code> is called after the response is received, the following 2925events will be emitted in the following order:</p> 2926<ul> 2927<li><code>'socket'</code></li> 2928<li><code>'response'</code> 2929<ul> 2930<li><code>'data'</code> any number of times, on the <code>res</code> object</li> 2931</ul> 2932</li> 2933<li>(<code>req.abort()</code> called here)</li> 2934<li><code>'abort'</code></li> 2935<li><code>'aborted'</code> on the <code>res</code> object</li> 2936<li><code>'close'</code></li> 2937<li><code>'close'</code> on the <code>res</code> object</li> 2938</ul> 2939<p>Setting the <code>timeout</code> option or using the <code>setTimeout()</code> function will 2940not abort the request or do anything besides add a <code>'timeout'</code> event.</p> 2941<p>Passing an <code>AbortSignal</code> and then calling <code>abort</code> on the corresponding 2942<code>AbortController</code> will behave the same way as calling <code>.destroy()</code> on the 2943request itself.</p> 2944</section><section><h3><code>http.validateHeaderName(name)</code><span><a class="mark" href="#http_http_validateheadername_name" id="http_http_validateheadername_name">#</a></span></h3> 2945<div class="api_metadata"> 2946<span>Added in: v14.3.0</span> 2947</div> 2948<ul> 2949<li><code>name</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 2950</ul> 2951<p>Performs the low-level validations on the provided <code>name</code> that are done when 2952<code>res.setHeader(name, value)</code> is called.</p> 2953<p>Passing illegal value as <code>name</code> will result in a <a href="errors.html#errors_class_typeerror"><code>TypeError</code></a> being thrown, 2954identified by <code>code: 'ERR_INVALID_HTTP_TOKEN'</code>.</p> 2955<p>It is not necessary to use this method before passing headers to an HTTP request 2956or response. The HTTP module will automatically validate such headers. 2957Examples:</p> 2958<p>Example:</p> 2959<pre><code class="language-js"><span class="hljs-keyword">const</span> { validateHeaderName } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'http'</span>); 2960 2961<span class="hljs-keyword">try</span> { 2962 <span class="hljs-title function_">validateHeaderName</span>(<span class="hljs-string">''</span>); 2963} <span class="hljs-keyword">catch</span> (err) { 2964 err <span class="hljs-keyword">instanceof</span> <span class="hljs-title class_">TypeError</span>; <span class="hljs-comment">// --> true</span> 2965 err.<span class="hljs-property">code</span>; <span class="hljs-comment">// --> 'ERR_INVALID_HTTP_TOKEN'</span> 2966 err.<span class="hljs-property">message</span>; <span class="hljs-comment">// --> 'Header name must be a valid HTTP token [""]'</span> 2967}</code></pre> 2968</section><section><h3><code>http.validateHeaderValue(name, value)</code><span><a class="mark" href="#http_http_validateheadervalue_name_value" id="http_http_validateheadervalue_name_value">#</a></span></h3> 2969<div class="api_metadata"> 2970<span>Added in: v14.3.0</span> 2971</div> 2972<ul> 2973<li><code>name</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 2974<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 2975</ul> 2976<p>Performs the low-level validations on the provided <code>value</code> that are done when 2977<code>res.setHeader(name, value)</code> is called.</p> 2978<p>Passing illegal value as <code>value</code> will result in a <a href="errors.html#errors_class_typeerror"><code>TypeError</code></a> being thrown.</p> 2979<ul> 2980<li>Undefined value error is identified by <code>code: 'ERR_HTTP_INVALID_HEADER_VALUE'</code>.</li> 2981<li>Invalid value character error is identified by <code>code: 'ERR_INVALID_CHAR'</code>.</li> 2982</ul> 2983<p>It is not necessary to use this method before passing headers to an HTTP request 2984or response. The HTTP module will automatically validate such headers.</p> 2985<p>Examples:</p> 2986<pre><code class="language-js"><span class="hljs-keyword">const</span> { validateHeaderValue } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'http'</span>); 2987 2988<span class="hljs-keyword">try</span> { 2989 <span class="hljs-title function_">validateHeaderValue</span>(<span class="hljs-string">'x-my-header'</span>, <span class="hljs-literal">undefined</span>); 2990} <span class="hljs-keyword">catch</span> (err) { 2991 err <span class="hljs-keyword">instanceof</span> <span class="hljs-title class_">TypeError</span>; <span class="hljs-comment">// --> true</span> 2992 err.<span class="hljs-property">code</span> === <span class="hljs-string">'ERR_HTTP_INVALID_HEADER_VALUE'</span>; <span class="hljs-comment">// --> true</span> 2993 err.<span class="hljs-property">message</span>; <span class="hljs-comment">// --> 'Invalid value "undefined" for header "x-my-header"'</span> 2994} 2995 2996<span class="hljs-keyword">try</span> { 2997 <span class="hljs-title function_">validateHeaderValue</span>(<span class="hljs-string">'x-my-header'</span>, <span class="hljs-string">'oʊmɪɡə'</span>); 2998} <span class="hljs-keyword">catch</span> (err) { 2999 err <span class="hljs-keyword">instanceof</span> <span class="hljs-title class_">TypeError</span>; <span class="hljs-comment">// --> true</span> 3000 err.<span class="hljs-property">code</span> === <span class="hljs-string">'ERR_INVALID_CHAR'</span>; <span class="hljs-comment">// --> true</span> 3001 err.<span class="hljs-property">message</span>; <span class="hljs-comment">// --> 'Invalid character in header content ["x-my-header"]'</span> 3002}</code></pre></section> 3003 <!-- API END --> 3004 </div> 3005 </div> 3006 </div> 3007 <script> 3008 'use strict'; 3009 { 3010 const kCustomPreference = 'customDarkTheme'; 3011 const userSettings = sessionStorage.getItem(kCustomPreference); 3012 const themeToggleButton = document.getElementById('theme-toggle-btn'); 3013 if (userSettings === null && window.matchMedia) { 3014 const mq = window.matchMedia('(prefers-color-scheme: dark)'); 3015 if ('onchange' in mq) { 3016 function mqChangeListener(e) { 3017 document.body.classList.toggle('dark-mode', e.matches); 3018 } 3019 mq.addEventListener('change', mqChangeListener); 3020 if (themeToggleButton) { 3021 themeToggleButton.addEventListener('click', function() { 3022 mq.removeEventListener('change', mqChangeListener); 3023 }, { once: true }); 3024 } 3025 } 3026 if (mq.matches) { 3027 document.body.classList.add('dark-mode'); 3028 } 3029 } else if (userSettings === 'true') { 3030 document.body.classList.add('dark-mode'); 3031 } 3032 if (themeToggleButton) { 3033 themeToggleButton.hidden = false; 3034 themeToggleButton.addEventListener('click', function() { 3035 sessionStorage.setItem( 3036 kCustomPreference, 3037 document.body.classList.toggle('dark-mode') 3038 ); 3039 }); 3040 } 3041 } 3042 </script> 3043</body> 3044</html> 3045