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="v18.20.1"> 7 <title>HTTP/2 | Node.js v18.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/http2.html"> 12 <script async defer src="assets/api.js" type="text/javascript"></script> 13 14</head> 15<body class="alt apidoc" id="api-section-http2"> 16 <div id="content" class="clearfix"> 17 <div id="column2" class="interior"> 18 <div id="intro" class="interior"> 19 <a href="/" title="Go back to the home page"> 20 Node.js 21 </a> 22 </div> 23 <ul> 24<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li> 25<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> 26</ul> 27<hr class="line"> 28<ul> 29<li><a href="assert.html" class="nav-assert">Assertion testing</a></li> 30<li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li> 31<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> 32<li><a href="buffer.html" class="nav-buffer">Buffer</a></li> 33<li><a href="addons.html" class="nav-addons">C++ addons</a></li> 34<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> 35<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li> 36<li><a href="child_process.html" class="nav-child_process">Child processes</a></li> 37<li><a href="cluster.html" class="nav-cluster">Cluster</a></li> 38<li><a href="cli.html" class="nav-cli">Command-line options</a></li> 39<li><a href="console.html" class="nav-console">Console</a></li> 40<li><a href="corepack.html" class="nav-corepack">Corepack</a></li> 41<li><a href="crypto.html" class="nav-crypto">Crypto</a></li> 42<li><a href="debugger.html" class="nav-debugger">Debugger</a></li> 43<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> 44<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> 45<li><a href="dns.html" class="nav-dns">DNS</a></li> 46<li><a href="domain.html" class="nav-domain">Domain</a></li> 47<li><a href="errors.html" class="nav-errors">Errors</a></li> 48<li><a href="events.html" class="nav-events">Events</a></li> 49<li><a href="fs.html" class="nav-fs">File system</a></li> 50<li><a href="globals.html" class="nav-globals">Globals</a></li> 51<li><a href="http.html" class="nav-http">HTTP</a></li> 52<li><a href="http2.html" class="nav-http2 active">HTTP/2</a></li> 53<li><a href="https.html" class="nav-https">HTTPS</a></li> 54<li><a href="inspector.html" class="nav-inspector">Inspector</a></li> 55<li><a href="intl.html" class="nav-intl">Internationalization</a></li> 56<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> 57<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> 58<li><a href="module.html" class="nav-module">Modules: <code>node:module</code> API</a></li> 59<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> 60<li><a href="net.html" class="nav-net">Net</a></li> 61<li><a href="os.html" class="nav-os">OS</a></li> 62<li><a href="path.html" class="nav-path">Path</a></li> 63<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> 64<li><a href="permissions.html" class="nav-permissions">Permissions</a></li> 65<li><a href="process.html" class="nav-process">Process</a></li> 66<li><a href="punycode.html" class="nav-punycode">Punycode</a></li> 67<li><a href="querystring.html" class="nav-querystring">Query strings</a></li> 68<li><a href="readline.html" class="nav-readline">Readline</a></li> 69<li><a href="repl.html" class="nav-repl">REPL</a></li> 70<li><a href="report.html" class="nav-report">Report</a></li> 71<li><a href="single-executable-applications.html" class="nav-single-executable-applications">Single executable applications</a></li> 72<li><a href="stream.html" class="nav-stream">Stream</a></li> 73<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li> 74<li><a href="test.html" class="nav-test">Test runner</a></li> 75<li><a href="timers.html" class="nav-timers">Timers</a></li> 76<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> 77<li><a href="tracing.html" class="nav-tracing">Trace events</a></li> 78<li><a href="tty.html" class="nav-tty">TTY</a></li> 79<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> 80<li><a href="url.html" class="nav-url">URL</a></li> 81<li><a href="util.html" class="nav-util">Utilities</a></li> 82<li><a href="v8.html" class="nav-v8">V8</a></li> 83<li><a href="vm.html" class="nav-vm">VM</a></li> 84<li><a href="wasi.html" class="nav-wasi">WASI</a></li> 85<li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li> 86<li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li> 87<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> 88<li><a href="zlib.html" class="nav-zlib">Zlib</a></li> 89</ul> 90<hr class="line"> 91<ul> 92<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> 93</ul> 94 </div> 95 96 <div id="column1" data-id="http2" class="interior"> 97 <header class="header"> 98 <div class="header-container"> 99 <h1>Node.js v18.20.1 documentation</h1> 100 <button class="theme-toggle-btn" id="theme-toggle-btn" title="Toggle dark mode/light mode" aria-label="Toggle dark mode/light mode" hidden> 101 <svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" height="24" width="24"> 102 <path fill="none" d="M0 0h24v24H0z" /> 103 <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"/> 104 <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"/> 105 </svg> 106 <svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" height="24" width="24"> 107 <path d="M0 0h24v24H0z" fill="none" /> 108 <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"/> 109 </svg> 110 </button> 111 </div> 112 <div id="gtoc"> 113 <ul> 114 <li class="pinned-header">Node.js v18.20.1</li> 115 116 <li class="picker-header"> 117 <a href="#"> 118 <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 119 Table of contents 120 </a> 121 122 <div class="picker"><div class="toc"><ul> 123<li><span class="stability_2"><a href="#http2">HTTP/2</a></span> 124<ul> 125<li><a href="#determining-if-crypto-support-is-unavailable">Determining if crypto support is unavailable</a></li> 126<li><a href="#core-api">Core API</a> 127<ul> 128<li><a href="#server-side-example">Server-side example</a></li> 129<li><a href="#client-side-example">Client-side example</a></li> 130<li><a href="#class-http2session">Class: <code>Http2Session</code></a> 131<ul> 132<li><a href="#http2session-and-sockets"><code>Http2Session</code> and sockets</a></li> 133<li><a href="#event-close">Event: <code>'close'</code></a></li> 134<li><a href="#event-connect">Event: <code>'connect'</code></a></li> 135<li><a href="#event-error">Event: <code>'error'</code></a></li> 136<li><a href="#event-frameerror">Event: <code>'frameError'</code></a></li> 137<li><a href="#event-goaway">Event: <code>'goaway'</code></a></li> 138<li><a href="#event-localsettings">Event: <code>'localSettings'</code></a></li> 139<li><a href="#event-ping">Event: <code>'ping'</code></a></li> 140<li><a href="#event-remotesettings">Event: <code>'remoteSettings'</code></a></li> 141<li><a href="#event-stream">Event: <code>'stream'</code></a></li> 142<li><a href="#event-timeout">Event: <code>'timeout'</code></a></li> 143<li><a href="#http2sessionalpnprotocol"><code>http2session.alpnProtocol</code></a></li> 144<li><a href="#http2sessionclosecallback"><code>http2session.close([callback])</code></a></li> 145<li><a href="#http2sessionclosed"><code>http2session.closed</code></a></li> 146<li><a href="#http2sessionconnecting"><code>http2session.connecting</code></a></li> 147<li><a href="#http2sessiondestroyerror-code"><code>http2session.destroy([error][, code])</code></a></li> 148<li><a href="#http2sessiondestroyed"><code>http2session.destroyed</code></a></li> 149<li><a href="#http2sessionencrypted"><code>http2session.encrypted</code></a></li> 150<li><a href="#http2sessiongoawaycode-laststreamid-opaquedata"><code>http2session.goaway([code[, lastStreamID[, opaqueData]]])</code></a></li> 151<li><a href="#http2sessionlocalsettings"><code>http2session.localSettings</code></a></li> 152<li><a href="#http2sessionoriginset"><code>http2session.originSet</code></a></li> 153<li><a href="#http2sessionpendingsettingsack"><code>http2session.pendingSettingsAck</code></a></li> 154<li><a href="#http2sessionpingpayload-callback"><code>http2session.ping([payload, ]callback)</code></a></li> 155<li><a href="#http2sessionref"><code>http2session.ref()</code></a></li> 156<li><a href="#http2sessionremotesettings"><code>http2session.remoteSettings</code></a></li> 157<li><a href="#http2sessionsetlocalwindowsizewindowsize"><code>http2session.setLocalWindowSize(windowSize)</code></a></li> 158<li><a href="#http2sessionsettimeoutmsecs-callback"><code>http2session.setTimeout(msecs, callback)</code></a></li> 159<li><a href="#http2sessionsocket"><code>http2session.socket</code></a></li> 160<li><a href="#http2sessionstate"><code>http2session.state</code></a></li> 161<li><a href="#http2sessionsettingssettings-callback"><code>http2session.settings([settings][, callback])</code></a></li> 162<li><a href="#http2sessiontype"><code>http2session.type</code></a></li> 163<li><a href="#http2sessionunref"><code>http2session.unref()</code></a></li> 164</ul> 165</li> 166<li><a href="#class-serverhttp2session">Class: <code>ServerHttp2Session</code></a> 167<ul> 168<li><a href="#serverhttp2sessionaltsvcalt-originorstream"><code>serverhttp2session.altsvc(alt, originOrStream)</code></a></li> 169<li><a href="#specifying-alternative-services">Specifying alternative services</a></li> 170<li><a href="#serverhttp2sessionoriginorigins"><code>serverhttp2session.origin(...origins)</code></a></li> 171</ul> 172</li> 173<li><a href="#class-clienthttp2session">Class: <code>ClientHttp2Session</code></a> 174<ul> 175<li><a href="#event-altsvc">Event: <code>'altsvc'</code></a></li> 176<li><a href="#event-origin">Event: <code>'origin'</code></a></li> 177<li><a href="#clienthttp2sessionrequestheaders-options"><code>clienthttp2session.request(headers[, options])</code></a></li> 178</ul> 179</li> 180<li><a href="#class-http2stream">Class: <code>Http2Stream</code></a> 181<ul> 182<li><a href="#http2stream-lifecycle"><code>Http2Stream</code> Lifecycle</a> 183<ul> 184<li><a href="#creation">Creation</a></li> 185<li><a href="#destruction">Destruction</a></li> 186</ul> 187</li> 188<li><a href="#event-aborted">Event: <code>'aborted'</code></a></li> 189<li><a href="#event-close_1">Event: <code>'close'</code></a></li> 190<li><a href="#event-error_1">Event: <code>'error'</code></a></li> 191<li><a href="#event-frameerror_1">Event: <code>'frameError'</code></a></li> 192<li><a href="#event-ready">Event: <code>'ready'</code></a></li> 193<li><a href="#event-timeout_1">Event: <code>'timeout'</code></a></li> 194<li><a href="#event-trailers">Event: <code>'trailers'</code></a></li> 195<li><a href="#event-wanttrailers">Event: <code>'wantTrailers'</code></a></li> 196<li><a href="#http2streamaborted"><code>http2stream.aborted</code></a></li> 197<li><a href="#http2streambuffersize"><code>http2stream.bufferSize</code></a></li> 198<li><a href="#http2streamclosecode-callback"><code>http2stream.close(code[, callback])</code></a></li> 199<li><a href="#http2streamclosed"><code>http2stream.closed</code></a></li> 200<li><a href="#http2streamdestroyed"><code>http2stream.destroyed</code></a></li> 201<li><a href="#http2streamendafterheaders"><code>http2stream.endAfterHeaders</code></a></li> 202<li><a href="#http2streamid"><code>http2stream.id</code></a></li> 203<li><a href="#http2streampending"><code>http2stream.pending</code></a></li> 204<li><a href="#http2streampriorityoptions"><code>http2stream.priority(options)</code></a></li> 205<li><a href="#http2streamrstcode"><code>http2stream.rstCode</code></a></li> 206<li><a href="#http2streamsentheaders"><code>http2stream.sentHeaders</code></a></li> 207<li><a href="#http2streamsentinfoheaders"><code>http2stream.sentInfoHeaders</code></a></li> 208<li><a href="#http2streamsenttrailers"><code>http2stream.sentTrailers</code></a></li> 209<li><a href="#http2streamsession"><code>http2stream.session</code></a></li> 210<li><a href="#http2streamsettimeoutmsecs-callback"><code>http2stream.setTimeout(msecs, callback)</code></a></li> 211<li><a href="#http2streamstate"><code>http2stream.state</code></a></li> 212<li><a href="#http2streamsendtrailersheaders"><code>http2stream.sendTrailers(headers)</code></a></li> 213</ul> 214</li> 215<li><a href="#class-clienthttp2stream">Class: <code>ClientHttp2Stream</code></a> 216<ul> 217<li><a href="#event-continue">Event: <code>'continue'</code></a></li> 218<li><a href="#event-headers">Event: <code>'headers'</code></a></li> 219<li><a href="#event-push">Event: <code>'push'</code></a></li> 220<li><a href="#event-response">Event: <code>'response'</code></a></li> 221</ul> 222</li> 223<li><a href="#class-serverhttp2stream">Class: <code>ServerHttp2Stream</code></a> 224<ul> 225<li><a href="#http2streamadditionalheadersheaders"><code>http2stream.additionalHeaders(headers)</code></a></li> 226<li><a href="#http2streamheaderssent"><code>http2stream.headersSent</code></a></li> 227<li><a href="#http2streampushallowed"><code>http2stream.pushAllowed</code></a></li> 228<li><a href="#http2streampushstreamheaders-options-callback"><code>http2stream.pushStream(headers[, options], callback)</code></a></li> 229<li><a href="#http2streamrespondheaders-options"><code>http2stream.respond([headers[, options]])</code></a></li> 230<li><a href="#http2streamrespondwithfdfd-headers-options"><code>http2stream.respondWithFD(fd[, headers[, options]])</code></a></li> 231<li><a href="#http2streamrespondwithfilepath-headers-options"><code>http2stream.respondWithFile(path[, headers[, options]])</code></a></li> 232</ul> 233</li> 234<li><a href="#class-http2server">Class: <code>Http2Server</code></a> 235<ul> 236<li><a href="#event-checkcontinue">Event: <code>'checkContinue'</code></a></li> 237<li><a href="#event-connection">Event: <code>'connection'</code></a></li> 238<li><a href="#event-request">Event: <code>'request'</code></a></li> 239<li><a href="#event-session">Event: <code>'session'</code></a></li> 240<li><a href="#event-sessionerror">Event: <code>'sessionError'</code></a></li> 241<li><a href="#event-stream_1">Event: <code>'stream'</code></a></li> 242<li><a href="#event-timeout_2">Event: <code>'timeout'</code></a></li> 243<li><a href="#serverclosecallback"><code>server.close([callback])</code></a></li> 244<li><a href="#serversettimeoutmsecs-callback"><code>server.setTimeout([msecs][, callback])</code></a></li> 245<li><a href="#servertimeout"><code>server.timeout</code></a></li> 246<li><a href="#serverupdatesettingssettings"><code>server.updateSettings([settings])</code></a></li> 247</ul> 248</li> 249<li><a href="#class-http2secureserver">Class: <code>Http2SecureServer</code></a> 250<ul> 251<li><a href="#event-checkcontinue_1">Event: <code>'checkContinue'</code></a></li> 252<li><a href="#event-connection_1">Event: <code>'connection'</code></a></li> 253<li><a href="#event-request_1">Event: <code>'request'</code></a></li> 254<li><a href="#event-session_1">Event: <code>'session'</code></a></li> 255<li><a href="#event-sessionerror_1">Event: <code>'sessionError'</code></a></li> 256<li><a href="#event-stream_2">Event: <code>'stream'</code></a></li> 257<li><a href="#event-timeout_3">Event: <code>'timeout'</code></a></li> 258<li><a href="#event-unknownprotocol">Event: <code>'unknownProtocol'</code></a></li> 259<li><a href="#serverclosecallback_1"><code>server.close([callback])</code></a></li> 260<li><a href="#serversettimeoutmsecs-callback_1"><code>server.setTimeout([msecs][, callback])</code></a></li> 261<li><a href="#servertimeout_1"><code>server.timeout</code></a></li> 262<li><a href="#serverupdatesettingssettings_1"><code>server.updateSettings([settings])</code></a></li> 263</ul> 264</li> 265<li><a href="#http2createserveroptions-onrequesthandler"><code>http2.createServer([options][, onRequestHandler])</code></a></li> 266<li><a href="#http2createsecureserveroptions-onrequesthandler"><code>http2.createSecureServer(options[, onRequestHandler])</code></a></li> 267<li><a href="#http2connectauthority-options-listener"><code>http2.connect(authority[, options][, listener])</code></a></li> 268<li><a href="#http2constants"><code>http2.constants</code></a> 269<ul> 270<li><a href="#error-codes-for-rst_stream-and-goaway">Error codes for <code>RST_STREAM</code> and <code>GOAWAY</code></a></li> 271</ul> 272</li> 273<li><a href="#http2getdefaultsettings"><code>http2.getDefaultSettings()</code></a></li> 274<li><a href="#http2getpackedsettingssettings"><code>http2.getPackedSettings([settings])</code></a></li> 275<li><a href="#http2getunpackedsettingsbuf"><code>http2.getUnpackedSettings(buf)</code></a></li> 276<li><a href="#http2sensitiveheaders"><code>http2.sensitiveHeaders</code></a></li> 277<li><a href="#headers-object">Headers object</a> 278<ul> 279<li><a href="#sensitive-headers">Sensitive headers</a></li> 280</ul> 281</li> 282<li><a href="#settings-object">Settings object</a></li> 283<li><a href="#error-handling">Error handling</a></li> 284<li><a href="#invalid-character-handling-in-header-names-and-values">Invalid character handling in header names and values</a></li> 285<li><a href="#push-streams-on-the-client">Push streams on the client</a></li> 286<li><a href="#supporting-the-connect-method">Supporting the <code>CONNECT</code> method</a></li> 287<li><a href="#the-extended-connect-protocol">The extended <code>CONNECT</code> protocol</a></li> 288</ul> 289</li> 290<li><a href="#compatibility-api">Compatibility API</a> 291<ul> 292<li><a href="#alpn-negotiation">ALPN negotiation</a></li> 293<li><a href="#class-http2http2serverrequest">Class: <code>http2.Http2ServerRequest</code></a> 294<ul> 295<li><a href="#event-aborted_1">Event: <code>'aborted'</code></a></li> 296<li><a href="#event-close_2">Event: <code>'close'</code></a></li> 297<li><a href="#requestaborted"><code>request.aborted</code></a></li> 298<li><a href="#requestauthority"><code>request.authority</code></a></li> 299<li><a href="#requestcomplete"><code>request.complete</code></a></li> 300<li><span class="stability_0"><a href="#requestconnection"><code>request.connection</code></a></span></li> 301<li><a href="#requestdestroyerror"><code>request.destroy([error])</code></a></li> 302<li><a href="#requestheaders"><code>request.headers</code></a></li> 303<li><a href="#requesthttpversion"><code>request.httpVersion</code></a></li> 304<li><a href="#requestmethod"><code>request.method</code></a></li> 305<li><a href="#requestrawheaders"><code>request.rawHeaders</code></a></li> 306<li><a href="#requestrawtrailers"><code>request.rawTrailers</code></a></li> 307<li><a href="#requestscheme"><code>request.scheme</code></a></li> 308<li><a href="#requestsettimeoutmsecs-callback"><code>request.setTimeout(msecs, callback)</code></a></li> 309<li><a href="#requestsocket"><code>request.socket</code></a></li> 310<li><a href="#requeststream"><code>request.stream</code></a></li> 311<li><a href="#requesttrailers"><code>request.trailers</code></a></li> 312<li><a href="#requesturl"><code>request.url</code></a></li> 313</ul> 314</li> 315<li><a href="#class-http2http2serverresponse">Class: <code>http2.Http2ServerResponse</code></a> 316<ul> 317<li><a href="#event-close_3">Event: <code>'close'</code></a></li> 318<li><a href="#event-finish">Event: <code>'finish'</code></a></li> 319<li><a href="#responseaddtrailersheaders"><code>response.addTrailers(headers)</code></a></li> 320<li><span class="stability_0"><a href="#responseconnection"><code>response.connection</code></a></span></li> 321<li><a href="#responsecreatepushresponseheaders-callback"><code>response.createPushResponse(headers, callback)</code></a></li> 322<li><a href="#responseenddata-encoding-callback"><code>response.end([data[, encoding]][, callback])</code></a></li> 323<li><span class="stability_0"><a href="#responsefinished"><code>response.finished</code></a></span></li> 324<li><a href="#responsegetheadername"><code>response.getHeader(name)</code></a></li> 325<li><a href="#responsegetheadernames"><code>response.getHeaderNames()</code></a></li> 326<li><a href="#responsegetheaders"><code>response.getHeaders()</code></a></li> 327<li><a href="#responsehasheadername"><code>response.hasHeader(name)</code></a></li> 328<li><a href="#responseheaderssent"><code>response.headersSent</code></a></li> 329<li><a href="#responseremoveheadername"><code>response.removeHeader(name)</code></a></li> 330<li><a href="#responsereq"><code>response.req</code></a></li> 331<li><a href="#responsesenddate"><code>response.sendDate</code></a></li> 332<li><a href="#responsesetheadername-value"><code>response.setHeader(name, value)</code></a></li> 333<li><a href="#responsesettimeoutmsecs-callback"><code>response.setTimeout(msecs[, callback])</code></a></li> 334<li><a href="#responsesocket"><code>response.socket</code></a></li> 335<li><a href="#responsestatuscode"><code>response.statusCode</code></a></li> 336<li><a href="#responsestatusmessage"><code>response.statusMessage</code></a></li> 337<li><a href="#responsestream"><code>response.stream</code></a></li> 338<li><a href="#responsewritableended"><code>response.writableEnded</code></a></li> 339<li><a href="#responsewritechunk-encoding-callback"><code>response.write(chunk[, encoding][, callback])</code></a></li> 340<li><a href="#responsewritecontinue"><code>response.writeContinue()</code></a></li> 341<li><a href="#responsewriteearlyhintshints"><code>response.writeEarlyHints(hints)</code></a></li> 342<li><a href="#responsewriteheadstatuscode-statusmessage-headers"><code>response.writeHead(statusCode[, statusMessage][, headers])</code></a></li> 343</ul> 344</li> 345</ul> 346</li> 347<li><a href="#collecting-http2-performance-metrics">Collecting HTTP/2 performance metrics</a></li> 348<li><a href="#note-on-authority-and-host">Note on <code>:authority</code> and <code>host</code></a></li> 349</ul> 350</li> 351</ul></div></div> 352 </li> 353 354 355 <li class="picker-header"> 356 <a href="#"> 357 <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 358 Index 359 </a> 360 361 <div class="picker"><ul> 362<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li> 363<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> 364 365 <li> 366 <a href="index.html">Index</a> 367 </li> 368 </ul> 369 370<hr class="line"> 371<ul> 372<li><a href="assert.html" class="nav-assert">Assertion testing</a></li> 373<li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li> 374<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> 375<li><a href="buffer.html" class="nav-buffer">Buffer</a></li> 376<li><a href="addons.html" class="nav-addons">C++ addons</a></li> 377<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> 378<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li> 379<li><a href="child_process.html" class="nav-child_process">Child processes</a></li> 380<li><a href="cluster.html" class="nav-cluster">Cluster</a></li> 381<li><a href="cli.html" class="nav-cli">Command-line options</a></li> 382<li><a href="console.html" class="nav-console">Console</a></li> 383<li><a href="corepack.html" class="nav-corepack">Corepack</a></li> 384<li><a href="crypto.html" class="nav-crypto">Crypto</a></li> 385<li><a href="debugger.html" class="nav-debugger">Debugger</a></li> 386<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> 387<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> 388<li><a href="dns.html" class="nav-dns">DNS</a></li> 389<li><a href="domain.html" class="nav-domain">Domain</a></li> 390<li><a href="errors.html" class="nav-errors">Errors</a></li> 391<li><a href="events.html" class="nav-events">Events</a></li> 392<li><a href="fs.html" class="nav-fs">File system</a></li> 393<li><a href="globals.html" class="nav-globals">Globals</a></li> 394<li><a href="http.html" class="nav-http">HTTP</a></li> 395<li><a href="http2.html" class="nav-http2 active">HTTP/2</a></li> 396<li><a href="https.html" class="nav-https">HTTPS</a></li> 397<li><a href="inspector.html" class="nav-inspector">Inspector</a></li> 398<li><a href="intl.html" class="nav-intl">Internationalization</a></li> 399<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> 400<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> 401<li><a href="module.html" class="nav-module">Modules: <code>node:module</code> API</a></li> 402<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> 403<li><a href="net.html" class="nav-net">Net</a></li> 404<li><a href="os.html" class="nav-os">OS</a></li> 405<li><a href="path.html" class="nav-path">Path</a></li> 406<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> 407<li><a href="permissions.html" class="nav-permissions">Permissions</a></li> 408<li><a href="process.html" class="nav-process">Process</a></li> 409<li><a href="punycode.html" class="nav-punycode">Punycode</a></li> 410<li><a href="querystring.html" class="nav-querystring">Query strings</a></li> 411<li><a href="readline.html" class="nav-readline">Readline</a></li> 412<li><a href="repl.html" class="nav-repl">REPL</a></li> 413<li><a href="report.html" class="nav-report">Report</a></li> 414<li><a href="single-executable-applications.html" class="nav-single-executable-applications">Single executable applications</a></li> 415<li><a href="stream.html" class="nav-stream">Stream</a></li> 416<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li> 417<li><a href="test.html" class="nav-test">Test runner</a></li> 418<li><a href="timers.html" class="nav-timers">Timers</a></li> 419<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> 420<li><a href="tracing.html" class="nav-tracing">Trace events</a></li> 421<li><a href="tty.html" class="nav-tty">TTY</a></li> 422<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> 423<li><a href="url.html" class="nav-url">URL</a></li> 424<li><a href="util.html" class="nav-util">Utilities</a></li> 425<li><a href="v8.html" class="nav-v8">V8</a></li> 426<li><a href="vm.html" class="nav-vm">VM</a></li> 427<li><a href="wasi.html" class="nav-wasi">WASI</a></li> 428<li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li> 429<li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li> 430<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> 431<li><a href="zlib.html" class="nav-zlib">Zlib</a></li> 432</ul> 433<hr class="line"> 434<ul> 435<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> 436</ul></div> 437 </li> 438 439 440 <li class="picker-header"> 441 <a href="#"> 442 <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 443 Other versions 444 </a> 445 <div class="picker"><ol id="alt-docs"><li><a href="https://nodejs.org/docs/latest-v21.x/api/http2.html">21.x</a></li> 446<li><a href="https://nodejs.org/docs/latest-v20.x/api/http2.html">20.x <b>LTS</b></a></li> 447<li><a href="https://nodejs.org/docs/latest-v19.x/api/http2.html">19.x</a></li> 448<li><a href="https://nodejs.org/docs/latest-v18.x/api/http2.html">18.x <b>LTS</b></a></li> 449<li><a href="https://nodejs.org/docs/latest-v17.x/api/http2.html">17.x</a></li> 450<li><a href="https://nodejs.org/docs/latest-v16.x/api/http2.html">16.x</a></li> 451<li><a href="https://nodejs.org/docs/latest-v15.x/api/http2.html">15.x</a></li> 452<li><a href="https://nodejs.org/docs/latest-v14.x/api/http2.html">14.x</a></li> 453<li><a href="https://nodejs.org/docs/latest-v13.x/api/http2.html">13.x</a></li> 454<li><a href="https://nodejs.org/docs/latest-v12.x/api/http2.html">12.x</a></li> 455<li><a href="https://nodejs.org/docs/latest-v11.x/api/http2.html">11.x</a></li> 456<li><a href="https://nodejs.org/docs/latest-v10.x/api/http2.html">10.x</a></li> 457<li><a href="https://nodejs.org/docs/latest-v9.x/api/http2.html">9.x</a></li> 458<li><a href="https://nodejs.org/docs/latest-v8.x/api/http2.html">8.x</a></li></ol></div> 459 </li> 460 461 <li class="picker-header"> 462 <a href="#"> 463 <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 464 Options 465 </a> 466 467 <div class="picker"> 468 <ul> 469 <li> 470 <a href="all.html">View on single page</a> 471 </li> 472 <li> 473 <a href="http2.json">View as JSON</a> 474 </li> 475 <li class="edit_on_github"><a href="https://github.com/nodejs/node/edit/main/doc/api/http2.md">Edit on GitHub</a></li> 476 </ul> 477 </div> 478 </li> 479 </ul> 480 </div> 481 <hr> 482 </header> 483 484 <details id="toc" open><summary>Table of contents</summary><ul> 485<li><span class="stability_2"><a href="#http2">HTTP/2</a></span> 486<ul> 487<li><a href="#determining-if-crypto-support-is-unavailable">Determining if crypto support is unavailable</a></li> 488<li><a href="#core-api">Core API</a> 489<ul> 490<li><a href="#server-side-example">Server-side example</a></li> 491<li><a href="#client-side-example">Client-side example</a></li> 492<li><a href="#class-http2session">Class: <code>Http2Session</code></a> 493<ul> 494<li><a href="#http2session-and-sockets"><code>Http2Session</code> and sockets</a></li> 495<li><a href="#event-close">Event: <code>'close'</code></a></li> 496<li><a href="#event-connect">Event: <code>'connect'</code></a></li> 497<li><a href="#event-error">Event: <code>'error'</code></a></li> 498<li><a href="#event-frameerror">Event: <code>'frameError'</code></a></li> 499<li><a href="#event-goaway">Event: <code>'goaway'</code></a></li> 500<li><a href="#event-localsettings">Event: <code>'localSettings'</code></a></li> 501<li><a href="#event-ping">Event: <code>'ping'</code></a></li> 502<li><a href="#event-remotesettings">Event: <code>'remoteSettings'</code></a></li> 503<li><a href="#event-stream">Event: <code>'stream'</code></a></li> 504<li><a href="#event-timeout">Event: <code>'timeout'</code></a></li> 505<li><a href="#http2sessionalpnprotocol"><code>http2session.alpnProtocol</code></a></li> 506<li><a href="#http2sessionclosecallback"><code>http2session.close([callback])</code></a></li> 507<li><a href="#http2sessionclosed"><code>http2session.closed</code></a></li> 508<li><a href="#http2sessionconnecting"><code>http2session.connecting</code></a></li> 509<li><a href="#http2sessiondestroyerror-code"><code>http2session.destroy([error][, code])</code></a></li> 510<li><a href="#http2sessiondestroyed"><code>http2session.destroyed</code></a></li> 511<li><a href="#http2sessionencrypted"><code>http2session.encrypted</code></a></li> 512<li><a href="#http2sessiongoawaycode-laststreamid-opaquedata"><code>http2session.goaway([code[, lastStreamID[, opaqueData]]])</code></a></li> 513<li><a href="#http2sessionlocalsettings"><code>http2session.localSettings</code></a></li> 514<li><a href="#http2sessionoriginset"><code>http2session.originSet</code></a></li> 515<li><a href="#http2sessionpendingsettingsack"><code>http2session.pendingSettingsAck</code></a></li> 516<li><a href="#http2sessionpingpayload-callback"><code>http2session.ping([payload, ]callback)</code></a></li> 517<li><a href="#http2sessionref"><code>http2session.ref()</code></a></li> 518<li><a href="#http2sessionremotesettings"><code>http2session.remoteSettings</code></a></li> 519<li><a href="#http2sessionsetlocalwindowsizewindowsize"><code>http2session.setLocalWindowSize(windowSize)</code></a></li> 520<li><a href="#http2sessionsettimeoutmsecs-callback"><code>http2session.setTimeout(msecs, callback)</code></a></li> 521<li><a href="#http2sessionsocket"><code>http2session.socket</code></a></li> 522<li><a href="#http2sessionstate"><code>http2session.state</code></a></li> 523<li><a href="#http2sessionsettingssettings-callback"><code>http2session.settings([settings][, callback])</code></a></li> 524<li><a href="#http2sessiontype"><code>http2session.type</code></a></li> 525<li><a href="#http2sessionunref"><code>http2session.unref()</code></a></li> 526</ul> 527</li> 528<li><a href="#class-serverhttp2session">Class: <code>ServerHttp2Session</code></a> 529<ul> 530<li><a href="#serverhttp2sessionaltsvcalt-originorstream"><code>serverhttp2session.altsvc(alt, originOrStream)</code></a></li> 531<li><a href="#specifying-alternative-services">Specifying alternative services</a></li> 532<li><a href="#serverhttp2sessionoriginorigins"><code>serverhttp2session.origin(...origins)</code></a></li> 533</ul> 534</li> 535<li><a href="#class-clienthttp2session">Class: <code>ClientHttp2Session</code></a> 536<ul> 537<li><a href="#event-altsvc">Event: <code>'altsvc'</code></a></li> 538<li><a href="#event-origin">Event: <code>'origin'</code></a></li> 539<li><a href="#clienthttp2sessionrequestheaders-options"><code>clienthttp2session.request(headers[, options])</code></a></li> 540</ul> 541</li> 542<li><a href="#class-http2stream">Class: <code>Http2Stream</code></a> 543<ul> 544<li><a href="#http2stream-lifecycle"><code>Http2Stream</code> Lifecycle</a> 545<ul> 546<li><a href="#creation">Creation</a></li> 547<li><a href="#destruction">Destruction</a></li> 548</ul> 549</li> 550<li><a href="#event-aborted">Event: <code>'aborted'</code></a></li> 551<li><a href="#event-close_1">Event: <code>'close'</code></a></li> 552<li><a href="#event-error_1">Event: <code>'error'</code></a></li> 553<li><a href="#event-frameerror_1">Event: <code>'frameError'</code></a></li> 554<li><a href="#event-ready">Event: <code>'ready'</code></a></li> 555<li><a href="#event-timeout_1">Event: <code>'timeout'</code></a></li> 556<li><a href="#event-trailers">Event: <code>'trailers'</code></a></li> 557<li><a href="#event-wanttrailers">Event: <code>'wantTrailers'</code></a></li> 558<li><a href="#http2streamaborted"><code>http2stream.aborted</code></a></li> 559<li><a href="#http2streambuffersize"><code>http2stream.bufferSize</code></a></li> 560<li><a href="#http2streamclosecode-callback"><code>http2stream.close(code[, callback])</code></a></li> 561<li><a href="#http2streamclosed"><code>http2stream.closed</code></a></li> 562<li><a href="#http2streamdestroyed"><code>http2stream.destroyed</code></a></li> 563<li><a href="#http2streamendafterheaders"><code>http2stream.endAfterHeaders</code></a></li> 564<li><a href="#http2streamid"><code>http2stream.id</code></a></li> 565<li><a href="#http2streampending"><code>http2stream.pending</code></a></li> 566<li><a href="#http2streampriorityoptions"><code>http2stream.priority(options)</code></a></li> 567<li><a href="#http2streamrstcode"><code>http2stream.rstCode</code></a></li> 568<li><a href="#http2streamsentheaders"><code>http2stream.sentHeaders</code></a></li> 569<li><a href="#http2streamsentinfoheaders"><code>http2stream.sentInfoHeaders</code></a></li> 570<li><a href="#http2streamsenttrailers"><code>http2stream.sentTrailers</code></a></li> 571<li><a href="#http2streamsession"><code>http2stream.session</code></a></li> 572<li><a href="#http2streamsettimeoutmsecs-callback"><code>http2stream.setTimeout(msecs, callback)</code></a></li> 573<li><a href="#http2streamstate"><code>http2stream.state</code></a></li> 574<li><a href="#http2streamsendtrailersheaders"><code>http2stream.sendTrailers(headers)</code></a></li> 575</ul> 576</li> 577<li><a href="#class-clienthttp2stream">Class: <code>ClientHttp2Stream</code></a> 578<ul> 579<li><a href="#event-continue">Event: <code>'continue'</code></a></li> 580<li><a href="#event-headers">Event: <code>'headers'</code></a></li> 581<li><a href="#event-push">Event: <code>'push'</code></a></li> 582<li><a href="#event-response">Event: <code>'response'</code></a></li> 583</ul> 584</li> 585<li><a href="#class-serverhttp2stream">Class: <code>ServerHttp2Stream</code></a> 586<ul> 587<li><a href="#http2streamadditionalheadersheaders"><code>http2stream.additionalHeaders(headers)</code></a></li> 588<li><a href="#http2streamheaderssent"><code>http2stream.headersSent</code></a></li> 589<li><a href="#http2streampushallowed"><code>http2stream.pushAllowed</code></a></li> 590<li><a href="#http2streampushstreamheaders-options-callback"><code>http2stream.pushStream(headers[, options], callback)</code></a></li> 591<li><a href="#http2streamrespondheaders-options"><code>http2stream.respond([headers[, options]])</code></a></li> 592<li><a href="#http2streamrespondwithfdfd-headers-options"><code>http2stream.respondWithFD(fd[, headers[, options]])</code></a></li> 593<li><a href="#http2streamrespondwithfilepath-headers-options"><code>http2stream.respondWithFile(path[, headers[, options]])</code></a></li> 594</ul> 595</li> 596<li><a href="#class-http2server">Class: <code>Http2Server</code></a> 597<ul> 598<li><a href="#event-checkcontinue">Event: <code>'checkContinue'</code></a></li> 599<li><a href="#event-connection">Event: <code>'connection'</code></a></li> 600<li><a href="#event-request">Event: <code>'request'</code></a></li> 601<li><a href="#event-session">Event: <code>'session'</code></a></li> 602<li><a href="#event-sessionerror">Event: <code>'sessionError'</code></a></li> 603<li><a href="#event-stream_1">Event: <code>'stream'</code></a></li> 604<li><a href="#event-timeout_2">Event: <code>'timeout'</code></a></li> 605<li><a href="#serverclosecallback"><code>server.close([callback])</code></a></li> 606<li><a href="#serversettimeoutmsecs-callback"><code>server.setTimeout([msecs][, callback])</code></a></li> 607<li><a href="#servertimeout"><code>server.timeout</code></a></li> 608<li><a href="#serverupdatesettingssettings"><code>server.updateSettings([settings])</code></a></li> 609</ul> 610</li> 611<li><a href="#class-http2secureserver">Class: <code>Http2SecureServer</code></a> 612<ul> 613<li><a href="#event-checkcontinue_1">Event: <code>'checkContinue'</code></a></li> 614<li><a href="#event-connection_1">Event: <code>'connection'</code></a></li> 615<li><a href="#event-request_1">Event: <code>'request'</code></a></li> 616<li><a href="#event-session_1">Event: <code>'session'</code></a></li> 617<li><a href="#event-sessionerror_1">Event: <code>'sessionError'</code></a></li> 618<li><a href="#event-stream_2">Event: <code>'stream'</code></a></li> 619<li><a href="#event-timeout_3">Event: <code>'timeout'</code></a></li> 620<li><a href="#event-unknownprotocol">Event: <code>'unknownProtocol'</code></a></li> 621<li><a href="#serverclosecallback_1"><code>server.close([callback])</code></a></li> 622<li><a href="#serversettimeoutmsecs-callback_1"><code>server.setTimeout([msecs][, callback])</code></a></li> 623<li><a href="#servertimeout_1"><code>server.timeout</code></a></li> 624<li><a href="#serverupdatesettingssettings_1"><code>server.updateSettings([settings])</code></a></li> 625</ul> 626</li> 627<li><a href="#http2createserveroptions-onrequesthandler"><code>http2.createServer([options][, onRequestHandler])</code></a></li> 628<li><a href="#http2createsecureserveroptions-onrequesthandler"><code>http2.createSecureServer(options[, onRequestHandler])</code></a></li> 629<li><a href="#http2connectauthority-options-listener"><code>http2.connect(authority[, options][, listener])</code></a></li> 630<li><a href="#http2constants"><code>http2.constants</code></a> 631<ul> 632<li><a href="#error-codes-for-rst_stream-and-goaway">Error codes for <code>RST_STREAM</code> and <code>GOAWAY</code></a></li> 633</ul> 634</li> 635<li><a href="#http2getdefaultsettings"><code>http2.getDefaultSettings()</code></a></li> 636<li><a href="#http2getpackedsettingssettings"><code>http2.getPackedSettings([settings])</code></a></li> 637<li><a href="#http2getunpackedsettingsbuf"><code>http2.getUnpackedSettings(buf)</code></a></li> 638<li><a href="#http2sensitiveheaders"><code>http2.sensitiveHeaders</code></a></li> 639<li><a href="#headers-object">Headers object</a> 640<ul> 641<li><a href="#sensitive-headers">Sensitive headers</a></li> 642</ul> 643</li> 644<li><a href="#settings-object">Settings object</a></li> 645<li><a href="#error-handling">Error handling</a></li> 646<li><a href="#invalid-character-handling-in-header-names-and-values">Invalid character handling in header names and values</a></li> 647<li><a href="#push-streams-on-the-client">Push streams on the client</a></li> 648<li><a href="#supporting-the-connect-method">Supporting the <code>CONNECT</code> method</a></li> 649<li><a href="#the-extended-connect-protocol">The extended <code>CONNECT</code> protocol</a></li> 650</ul> 651</li> 652<li><a href="#compatibility-api">Compatibility API</a> 653<ul> 654<li><a href="#alpn-negotiation">ALPN negotiation</a></li> 655<li><a href="#class-http2http2serverrequest">Class: <code>http2.Http2ServerRequest</code></a> 656<ul> 657<li><a href="#event-aborted_1">Event: <code>'aborted'</code></a></li> 658<li><a href="#event-close_2">Event: <code>'close'</code></a></li> 659<li><a href="#requestaborted"><code>request.aborted</code></a></li> 660<li><a href="#requestauthority"><code>request.authority</code></a></li> 661<li><a href="#requestcomplete"><code>request.complete</code></a></li> 662<li><span class="stability_0"><a href="#requestconnection"><code>request.connection</code></a></span></li> 663<li><a href="#requestdestroyerror"><code>request.destroy([error])</code></a></li> 664<li><a href="#requestheaders"><code>request.headers</code></a></li> 665<li><a href="#requesthttpversion"><code>request.httpVersion</code></a></li> 666<li><a href="#requestmethod"><code>request.method</code></a></li> 667<li><a href="#requestrawheaders"><code>request.rawHeaders</code></a></li> 668<li><a href="#requestrawtrailers"><code>request.rawTrailers</code></a></li> 669<li><a href="#requestscheme"><code>request.scheme</code></a></li> 670<li><a href="#requestsettimeoutmsecs-callback"><code>request.setTimeout(msecs, callback)</code></a></li> 671<li><a href="#requestsocket"><code>request.socket</code></a></li> 672<li><a href="#requeststream"><code>request.stream</code></a></li> 673<li><a href="#requesttrailers"><code>request.trailers</code></a></li> 674<li><a href="#requesturl"><code>request.url</code></a></li> 675</ul> 676</li> 677<li><a href="#class-http2http2serverresponse">Class: <code>http2.Http2ServerResponse</code></a> 678<ul> 679<li><a href="#event-close_3">Event: <code>'close'</code></a></li> 680<li><a href="#event-finish">Event: <code>'finish'</code></a></li> 681<li><a href="#responseaddtrailersheaders"><code>response.addTrailers(headers)</code></a></li> 682<li><span class="stability_0"><a href="#responseconnection"><code>response.connection</code></a></span></li> 683<li><a href="#responsecreatepushresponseheaders-callback"><code>response.createPushResponse(headers, callback)</code></a></li> 684<li><a href="#responseenddata-encoding-callback"><code>response.end([data[, encoding]][, callback])</code></a></li> 685<li><span class="stability_0"><a href="#responsefinished"><code>response.finished</code></a></span></li> 686<li><a href="#responsegetheadername"><code>response.getHeader(name)</code></a></li> 687<li><a href="#responsegetheadernames"><code>response.getHeaderNames()</code></a></li> 688<li><a href="#responsegetheaders"><code>response.getHeaders()</code></a></li> 689<li><a href="#responsehasheadername"><code>response.hasHeader(name)</code></a></li> 690<li><a href="#responseheaderssent"><code>response.headersSent</code></a></li> 691<li><a href="#responseremoveheadername"><code>response.removeHeader(name)</code></a></li> 692<li><a href="#responsereq"><code>response.req</code></a></li> 693<li><a href="#responsesenddate"><code>response.sendDate</code></a></li> 694<li><a href="#responsesetheadername-value"><code>response.setHeader(name, value)</code></a></li> 695<li><a href="#responsesettimeoutmsecs-callback"><code>response.setTimeout(msecs[, callback])</code></a></li> 696<li><a href="#responsesocket"><code>response.socket</code></a></li> 697<li><a href="#responsestatuscode"><code>response.statusCode</code></a></li> 698<li><a href="#responsestatusmessage"><code>response.statusMessage</code></a></li> 699<li><a href="#responsestream"><code>response.stream</code></a></li> 700<li><a href="#responsewritableended"><code>response.writableEnded</code></a></li> 701<li><a href="#responsewritechunk-encoding-callback"><code>response.write(chunk[, encoding][, callback])</code></a></li> 702<li><a href="#responsewritecontinue"><code>response.writeContinue()</code></a></li> 703<li><a href="#responsewriteearlyhintshints"><code>response.writeEarlyHints(hints)</code></a></li> 704<li><a href="#responsewriteheadstatuscode-statusmessage-headers"><code>response.writeHead(statusCode[, statusMessage][, headers])</code></a></li> 705</ul> 706</li> 707</ul> 708</li> 709<li><a href="#collecting-http2-performance-metrics">Collecting HTTP/2 performance metrics</a></li> 710<li><a href="#note-on-authority-and-host">Note on <code>:authority</code> and <code>host</code></a></li> 711</ul> 712</li> 713</ul></details> 714 715 <div id="apicontent"> 716 <h2>HTTP/2<span><a class="mark" href="#http2" id="http2">#</a></span><a aria-hidden="true" class="legacy" id="http2_http_2"></a></h2> 717<div class="api_metadata"> 718<details class="changelog"><summary>History</summary> 719<table> 720<tbody><tr><th>Version</th><th>Changes</th></tr> 721<tr><td>v15.0.0</td> 722<td><p>Requests with the <code>host</code> header (with or without <code>:authority</code>) can now be sent/received.</p></td></tr> 723<tr><td>v15.3.0, v14.17.0</td> 724<td><p>It is possible to abort a request with an AbortSignal.</p></td></tr> 725<tr><td>v10.10.0</td> 726<td><p>HTTP/2 is now Stable. Previously, it had been Experimental.</p></td></tr> 727<tr><td>v8.4.0</td> 728<td><p><span>Added in: v8.4.0</span></p></td></tr> 729</tbody></table> 730</details> 731</div> 732 733<p></p><div class="api_stability api_stability_2"><a href="documentation.html#stability-index">Stability: 2</a> - Stable</div><p></p> 734<p><strong>Source Code:</strong> <a href="https://github.com/nodejs/node/blob/v18.20.1/lib/http2.js">lib/http2.js</a></p> 735<p>The <code>node:http2</code> module provides an implementation of the <a href="https://tools.ietf.org/html/rfc7540">HTTP/2</a> protocol. 736It can be accessed using:</p> 737<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>);</code> <button class="copy-button">copy</button></pre> 738<section><h3>Determining if crypto support is unavailable<span><a class="mark" href="#determining-if-crypto-support-is-unavailable" id="determining-if-crypto-support-is-unavailable">#</a></span><a aria-hidden="true" class="legacy" id="http2_determining_if_crypto_support_is_unavailable"></a></h3> 739<p>It is possible for Node.js to be built without including support for the 740<code>node:crypto</code> module. In such cases, attempting to <code>import</code> from <code>node:http2</code> or 741calling <code>require('node:http2')</code> will result in an error being thrown.</p> 742<p>When using CommonJS, the error thrown can be caught using try/catch:</p> 743<pre><code class="language-js cjs"><span class="hljs-keyword">let</span> http2; 744<span class="hljs-keyword">try</span> { 745 http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 746} <span class="hljs-keyword">catch</span> (err) { 747 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">error</span>(<span class="hljs-string">'http2 support is disabled!'</span>); 748}</code> <button class="copy-button">copy</button></pre> 749<p>When using the lexical ESM <code>import</code> keyword, the error can only be 750caught if a handler for <code>process.on('uncaughtException')</code> is registered 751<em>before</em> any attempt to load the module is made (using, for instance, 752a preload module).</p> 753<p>When using ESM, if there is a chance that the code may be run on a build 754of Node.js where crypto support is not enabled, consider using the 755<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/import"><code>import()</code></a> function instead of the lexical <code>import</code> keyword:</p> 756<pre><code class="language-js mjs"><span class="hljs-keyword">let</span> http2; 757<span class="hljs-keyword">try</span> { 758 http2 = <span class="hljs-keyword">await</span> <span class="hljs-keyword">import</span>(<span class="hljs-string">'node:http2'</span>); 759} <span class="hljs-keyword">catch</span> (err) { 760 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">error</span>(<span class="hljs-string">'http2 support is disabled!'</span>); 761}</code> <button class="copy-button">copy</button></pre> 762</section><section><h3>Core API<span><a class="mark" href="#core-api" id="core-api">#</a></span><a aria-hidden="true" class="legacy" id="http2_core_api"></a></h3> 763<p>The Core API provides a low-level interface designed specifically around 764support for HTTP/2 protocol features. It is specifically <em>not</em> designed for 765compatibility with the existing <a href="http.html">HTTP/1</a> module API. However, 766the <a href="#compatibility-api">Compatibility API</a> is.</p> 767<p>The <code>http2</code> Core API is much more symmetric between client and server than the 768<code>http</code> API. For instance, most events, like <code>'error'</code>, <code>'connect'</code> and 769<code>'stream'</code>, can be emitted either by client-side code or server-side code.</p> 770<h4>Server-side example<span><a class="mark" href="#server-side-example" id="server-side-example">#</a></span><a aria-hidden="true" class="legacy" id="http2_server_side_example"></a></h4> 771<p>The following illustrates a simple HTTP/2 server using the Core API. 772Since there are no browsers known that support 773<a href="https://http2.github.io/faq/#does-http2-require-encryption">unencrypted HTTP/2</a>, the use of 774<a href="#http2createsecureserveroptions-onrequesthandler"><code>http2.createSecureServer()</code></a> is necessary when communicating 775with browser clients.</p> 776<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 777<span class="hljs-keyword">const</span> fs = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:fs'</span>); 778 779<span class="hljs-keyword">const</span> server = http2.<span class="hljs-title function_">createSecureServer</span>({ 780 <span class="hljs-attr">key</span>: fs.<span class="hljs-title function_">readFileSync</span>(<span class="hljs-string">'localhost-privkey.pem'</span>), 781 <span class="hljs-attr">cert</span>: fs.<span class="hljs-title function_">readFileSync</span>(<span class="hljs-string">'localhost-cert.pem'</span>), 782}); 783server.<span class="hljs-title function_">on</span>(<span class="hljs-string">'error'</span>, <span class="hljs-function">(<span class="hljs-params">err</span>) =></span> <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">error</span>(err)); 784 785server.<span class="hljs-title function_">on</span>(<span class="hljs-string">'stream'</span>, <span class="hljs-function">(<span class="hljs-params">stream, headers</span>) =></span> { 786 <span class="hljs-comment">// stream is a Duplex</span> 787 stream.<span class="hljs-title function_">respond</span>({ 788 <span class="hljs-string">'content-type'</span>: <span class="hljs-string">'text/html; charset=utf-8'</span>, 789 <span class="hljs-string">':status'</span>: <span class="hljs-number">200</span>, 790 }); 791 stream.<span class="hljs-title function_">end</span>(<span class="hljs-string">'<h1>Hello World</h1>'</span>); 792}); 793 794server.<span class="hljs-title function_">listen</span>(<span class="hljs-number">8443</span>);</code> <button class="copy-button">copy</button></pre> 795<p>To generate the certificate and key for this example, run:</p> 796<pre><code class="language-bash">openssl req -x509 -newkey rsa:2048 -nodes -sha256 -subj <span class="hljs-string">'/CN=localhost'</span> \ 797 -keyout localhost-privkey.pem -out localhost-cert.pem</code> <button class="copy-button">copy</button></pre> 798<h4>Client-side example<span><a class="mark" href="#client-side-example" id="client-side-example">#</a></span><a aria-hidden="true" class="legacy" id="http2_client_side_example"></a></h4> 799<p>The following illustrates an HTTP/2 client:</p> 800<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 801<span class="hljs-keyword">const</span> fs = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:fs'</span>); 802<span class="hljs-keyword">const</span> client = http2.<span class="hljs-title function_">connect</span>(<span class="hljs-string">'https://localhost:8443'</span>, { 803 <span class="hljs-attr">ca</span>: fs.<span class="hljs-title function_">readFileSync</span>(<span class="hljs-string">'localhost-cert.pem'</span>), 804}); 805client.<span class="hljs-title function_">on</span>(<span class="hljs-string">'error'</span>, <span class="hljs-function">(<span class="hljs-params">err</span>) =></span> <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">error</span>(err)); 806 807<span class="hljs-keyword">const</span> req = client.<span class="hljs-title function_">request</span>({ <span class="hljs-string">':path'</span>: <span class="hljs-string">'/'</span> }); 808 809req.<span class="hljs-title function_">on</span>(<span class="hljs-string">'response'</span>, <span class="hljs-function">(<span class="hljs-params">headers, flags</span>) =></span> { 810 <span class="hljs-keyword">for</span> (<span class="hljs-keyword">const</span> name <span class="hljs-keyword">in</span> headers) { 811 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">`<span class="hljs-subst">${name}</span>: <span class="hljs-subst">${headers[name]}</span>`</span>); 812 } 813}); 814 815req.<span class="hljs-title function_">setEncoding</span>(<span class="hljs-string">'utf8'</span>); 816<span class="hljs-keyword">let</span> data = <span class="hljs-string">''</span>; 817req.<span class="hljs-title function_">on</span>(<span class="hljs-string">'data'</span>, <span class="hljs-function">(<span class="hljs-params">chunk</span>) =></span> { data += chunk; }); 818req.<span class="hljs-title function_">on</span>(<span class="hljs-string">'end'</span>, <span class="hljs-function">() =></span> { 819 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">`\n<span class="hljs-subst">${data}</span>`</span>); 820 client.<span class="hljs-title function_">close</span>(); 821}); 822req.<span class="hljs-title function_">end</span>();</code> <button class="copy-button">copy</button></pre> 823<h4>Class: <code>Http2Session</code><span><a class="mark" href="#class-http2session" id="class-http2session">#</a></span><a aria-hidden="true" class="legacy" id="http2_class_http2session"></a></h4> 824<div class="api_metadata"> 825<span>Added in: v8.4.0</span> 826</div> 827<ul> 828<li>Extends: <a href="events.html#class-eventemitter" class="type"><EventEmitter></a></li> 829</ul> 830<p>Instances of the <code>http2.Http2Session</code> class represent an active communications 831session between an HTTP/2 client and server. Instances of this class are <em>not</em> 832intended to be constructed directly by user code.</p> 833<p>Each <code>Http2Session</code> instance will exhibit slightly different behaviors 834depending on whether it is operating as a server or a client. The 835<code>http2session.type</code> property can be used to determine the mode in which an 836<code>Http2Session</code> is operating. On the server side, user code should rarely 837have occasion to work with the <code>Http2Session</code> object directly, with most 838actions typically taken through interactions with either the <code>Http2Server</code> or 839<code>Http2Stream</code> objects.</p> 840<p>User code will not create <code>Http2Session</code> instances directly. Server-side 841<code>Http2Session</code> instances are created by the <code>Http2Server</code> instance when a 842new HTTP/2 connection is received. Client-side <code>Http2Session</code> instances are 843created using the <code>http2.connect()</code> method.</p> 844<h5><code>Http2Session</code> and sockets<span><a class="mark" href="#http2session-and-sockets" id="http2session-and-sockets">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2session_and_sockets"></a></h5> 845<p>Every <code>Http2Session</code> instance is associated with exactly one <a href="net.html#class-netsocket"><code>net.Socket</code></a> or 846<a href="tls.html#class-tlstlssocket"><code>tls.TLSSocket</code></a> when it is created. When either the <code>Socket</code> or the 847<code>Http2Session</code> are destroyed, both will be destroyed.</p> 848<p>Because of the specific serialization and processing requirements imposed 849by the HTTP/2 protocol, it is not recommended for user code to read data from 850or write data to a <code>Socket</code> instance bound to a <code>Http2Session</code>. Doing so can 851put the HTTP/2 session into an indeterminate state causing the session and 852the socket to become unusable.</p> 853<p>Once a <code>Socket</code> has been bound to an <code>Http2Session</code>, user code should rely 854solely on the API of the <code>Http2Session</code>.</p> 855<h5>Event: <code>'close'</code><span><a class="mark" href="#event-close" id="event-close">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_close"></a></h5> 856<div class="api_metadata"> 857<span>Added in: v8.4.0</span> 858</div> 859<p>The <code>'close'</code> event is emitted once the <code>Http2Session</code> has been destroyed. Its 860listener does not expect any arguments.</p> 861<h5>Event: <code>'connect'</code><span><a class="mark" href="#event-connect" id="event-connect">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_connect"></a></h5> 862<div class="api_metadata"> 863<span>Added in: v8.4.0</span> 864</div> 865<ul> 866<li><code>session</code> <a href="http2.html#class-http2session" class="type"><Http2Session></a></li> 867<li><code>socket</code> <a href="net.html#class-netsocket" class="type"><net.Socket></a></li> 868</ul> 869<p>The <code>'connect'</code> event is emitted once the <code>Http2Session</code> has been successfully 870connected to the remote peer and communication may begin.</p> 871<p>User code will typically not listen for this event directly.</p> 872<h5>Event: <code>'error'</code><span><a class="mark" href="#event-error" id="event-error">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_error"></a></h5> 873<div class="api_metadata"> 874<span>Added in: v8.4.0</span> 875</div> 876<ul> 877<li><code>error</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" class="type"><Error></a></li> 878</ul> 879<p>The <code>'error'</code> event is emitted when an error occurs during the processing of 880an <code>Http2Session</code>.</p> 881<h5>Event: <code>'frameError'</code><span><a class="mark" href="#event-frameerror" id="event-frameerror">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_frameerror"></a></h5> 882<div class="api_metadata"> 883<span>Added in: v8.4.0</span> 884</div> 885<ul> 886<li><code>type</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><integer></a> The frame type.</li> 887<li><code>code</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><integer></a> The error code.</li> 888<li><code>id</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><integer></a> The stream id (or <code>0</code> if the frame isn't associated with a 889stream).</li> 890</ul> 891<p>The <code>'frameError'</code> event is emitted when an error occurs while attempting to 892send a frame on the session. If the frame that could not be sent is associated 893with a specific <code>Http2Stream</code>, an attempt to emit a <code>'frameError'</code> event on the 894<code>Http2Stream</code> is made.</p> 895<p>If the <code>'frameError'</code> event is associated with a stream, the stream will be 896closed and destroyed immediately following the <code>'frameError'</code> event. If the 897event is not associated with a stream, the <code>Http2Session</code> will be shut down 898immediately following the <code>'frameError'</code> event.</p> 899<h5>Event: <code>'goaway'</code><span><a class="mark" href="#event-goaway" id="event-goaway">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_goaway"></a></h5> 900<div class="api_metadata"> 901<span>Added in: v8.4.0</span> 902</div> 903<ul> 904<li><code>errorCode</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The HTTP/2 error code specified in the <code>GOAWAY</code> frame.</li> 905<li><code>lastStreamID</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The ID of the last stream the remote peer successfully 906processed (or <code>0</code> if no ID is specified).</li> 907<li><code>opaqueData</code> <a href="buffer.html#class-buffer" class="type"><Buffer></a> If additional opaque data was included in the <code>GOAWAY</code> 908frame, a <code>Buffer</code> instance will be passed containing that data.</li> 909</ul> 910<p>The <code>'goaway'</code> event is emitted when a <code>GOAWAY</code> frame is received.</p> 911<p>The <code>Http2Session</code> instance will be shut down automatically when the <code>'goaway'</code> 912event is emitted.</p> 913<h5>Event: <code>'localSettings'</code><span><a class="mark" href="#event-localsettings" id="event-localsettings">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_localsettings"></a></h5> 914<div class="api_metadata"> 915<span>Added in: v8.4.0</span> 916</div> 917<ul> 918<li><code>settings</code> <a href="http2.html#settings-object" class="type"><HTTP/2 Settings Object></a> A copy of the <code>SETTINGS</code> frame received.</li> 919</ul> 920<p>The <code>'localSettings'</code> event is emitted when an acknowledgment <code>SETTINGS</code> frame 921has been received.</p> 922<p>When using <code>http2session.settings()</code> to submit new settings, the modified 923settings do not take effect until the <code>'localSettings'</code> event is emitted.</p> 924<pre><code class="language-js">session.<span class="hljs-title function_">settings</span>({ <span class="hljs-attr">enablePush</span>: <span class="hljs-literal">false</span> }); 925 926session.<span class="hljs-title function_">on</span>(<span class="hljs-string">'localSettings'</span>, <span class="hljs-function">(<span class="hljs-params">settings</span>) =></span> { 927 <span class="hljs-comment">/* Use the new settings */</span> 928});</code> <button class="copy-button">copy</button></pre> 929<h5>Event: <code>'ping'</code><span><a class="mark" href="#event-ping" id="event-ping">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_ping"></a></h5> 930<div class="api_metadata"> 931<span>Added in: v10.12.0</span> 932</div> 933<ul> 934<li><code>payload</code> <a href="buffer.html#class-buffer" class="type"><Buffer></a> The <code>PING</code> frame 8-byte payload</li> 935</ul> 936<p>The <code>'ping'</code> event is emitted whenever a <code>PING</code> frame is received from the 937connected peer.</p> 938<h5>Event: <code>'remoteSettings'</code><span><a class="mark" href="#event-remotesettings" id="event-remotesettings">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_remotesettings"></a></h5> 939<div class="api_metadata"> 940<span>Added in: v8.4.0</span> 941</div> 942<ul> 943<li><code>settings</code> <a href="http2.html#settings-object" class="type"><HTTP/2 Settings Object></a> A copy of the <code>SETTINGS</code> frame received.</li> 944</ul> 945<p>The <code>'remoteSettings'</code> event is emitted when a new <code>SETTINGS</code> frame is received 946from the connected peer.</p> 947<pre><code class="language-js">session.<span class="hljs-title function_">on</span>(<span class="hljs-string">'remoteSettings'</span>, <span class="hljs-function">(<span class="hljs-params">settings</span>) =></span> { 948 <span class="hljs-comment">/* Use the new settings */</span> 949});</code> <button class="copy-button">copy</button></pre> 950<h5>Event: <code>'stream'</code><span><a class="mark" href="#event-stream" id="event-stream">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_stream"></a></h5> 951<div class="api_metadata"> 952<span>Added in: v8.4.0</span> 953</div> 954<ul> 955<li><code>stream</code> <a href="http2.html#class-http2stream" class="type"><Http2Stream></a> A reference to the stream</li> 956<li><code>headers</code> <a href="http2.html#headers-object" class="type"><HTTP/2 Headers Object></a> An object describing the headers</li> 957<li><code>flags</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The associated numeric flags</li> 958<li><code>rawHeaders</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="type"><Array></a> An array containing the raw header names followed by 959their respective values.</li> 960</ul> 961<p>The <code>'stream'</code> event is emitted when a new <code>Http2Stream</code> is created.</p> 962<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 963session.<span class="hljs-title function_">on</span>(<span class="hljs-string">'stream'</span>, <span class="hljs-function">(<span class="hljs-params">stream, headers, flags</span>) =></span> { 964 <span class="hljs-keyword">const</span> method = headers[<span class="hljs-string">':method'</span>]; 965 <span class="hljs-keyword">const</span> path = headers[<span class="hljs-string">':path'</span>]; 966 <span class="hljs-comment">// ...</span> 967 stream.<span class="hljs-title function_">respond</span>({ 968 <span class="hljs-string">':status'</span>: <span class="hljs-number">200</span>, 969 <span class="hljs-string">'content-type'</span>: <span class="hljs-string">'text/plain; charset=utf-8'</span>, 970 }); 971 stream.<span class="hljs-title function_">write</span>(<span class="hljs-string">'hello '</span>); 972 stream.<span class="hljs-title function_">end</span>(<span class="hljs-string">'world'</span>); 973});</code> <button class="copy-button">copy</button></pre> 974<p>On the server side, user code will typically not listen for this event directly, 975and would instead register a handler for the <code>'stream'</code> event emitted by the 976<code>net.Server</code> or <code>tls.Server</code> instances returned by <code>http2.createServer()</code> and 977<code>http2.createSecureServer()</code>, respectively, as in the example below:</p> 978<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 979 980<span class="hljs-comment">// Create an unencrypted HTTP/2 server</span> 981<span class="hljs-keyword">const</span> server = http2.<span class="hljs-title function_">createServer</span>(); 982 983server.<span class="hljs-title function_">on</span>(<span class="hljs-string">'stream'</span>, <span class="hljs-function">(<span class="hljs-params">stream, headers</span>) =></span> { 984 stream.<span class="hljs-title function_">respond</span>({ 985 <span class="hljs-string">'content-type'</span>: <span class="hljs-string">'text/html; charset=utf-8'</span>, 986 <span class="hljs-string">':status'</span>: <span class="hljs-number">200</span>, 987 }); 988 stream.<span class="hljs-title function_">on</span>(<span class="hljs-string">'error'</span>, <span class="hljs-function">(<span class="hljs-params">error</span>) =></span> <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">error</span>(error)); 989 stream.<span class="hljs-title function_">end</span>(<span class="hljs-string">'<h1>Hello World</h1>'</span>); 990}); 991 992server.<span class="hljs-title function_">listen</span>(<span class="hljs-number">8000</span>);</code> <button class="copy-button">copy</button></pre> 993<p>Even though HTTP/2 streams and network sockets are not in a 1:1 correspondence, 994a network error will destroy each individual stream and must be handled on the 995stream level, as shown above.</p> 996<h5>Event: <code>'timeout'</code><span><a class="mark" href="#event-timeout" id="event-timeout">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_timeout"></a></h5> 997<div class="api_metadata"> 998<span>Added in: v8.4.0</span> 999</div> 1000<p>After the <code>http2session.setTimeout()</code> method is used to set the timeout period 1001for this <code>Http2Session</code>, the <code>'timeout'</code> event is emitted if there is no 1002activity on the <code>Http2Session</code> after the configured number of milliseconds. 1003Its listener does not expect any arguments.</p> 1004<pre><code class="language-js">session.<span class="hljs-built_in">setTimeout</span>(<span class="hljs-number">2000</span>); 1005session.<span class="hljs-title function_">on</span>(<span class="hljs-string">'timeout'</span>, <span class="hljs-function">() =></span> { <span class="hljs-comment">/* .. */</span> });</code> <button class="copy-button">copy</button></pre> 1006<h5><code>http2session.alpnProtocol</code><span><a class="mark" href="#http2sessionalpnprotocol" id="http2sessionalpnprotocol">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2session_alpnprotocol"></a></h5> 1007<div class="api_metadata"> 1008<span>Added in: v9.4.0</span> 1009</div> 1010<ul> 1011<li><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> 1012</ul> 1013<p>Value will be <code>undefined</code> if the <code>Http2Session</code> is not yet connected to a 1014socket, <code>h2c</code> if the <code>Http2Session</code> is not connected to a <code>TLSSocket</code>, or 1015will return the value of the connected <code>TLSSocket</code>'s own <code>alpnProtocol</code> 1016property.</p> 1017<h5><code>http2session.close([callback])</code><span><a class="mark" href="#http2sessionclosecallback" id="http2sessionclosecallback">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2session_close_callback"></a></h5> 1018<div class="api_metadata"> 1019<span>Added in: v9.4.0</span> 1020</div> 1021<ul> 1022<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 1023</ul> 1024<p>Gracefully closes the <code>Http2Session</code>, allowing any existing streams to 1025complete on their own and preventing new <code>Http2Stream</code> instances from being 1026created. Once closed, <code>http2session.destroy()</code> <em>might</em> be called if there 1027are no open <code>Http2Stream</code> instances.</p> 1028<p>If specified, the <code>callback</code> function is registered as a handler for the 1029<code>'close'</code> event.</p> 1030<h5><code>http2session.closed</code><span><a class="mark" href="#http2sessionclosed" id="http2sessionclosed">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2session_closed"></a></h5> 1031<div class="api_metadata"> 1032<span>Added in: v9.4.0</span> 1033</div> 1034<ul> 1035<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1036</ul> 1037<p>Will be <code>true</code> if this <code>Http2Session</code> instance has been closed, otherwise 1038<code>false</code>.</p> 1039<h5><code>http2session.connecting</code><span><a class="mark" href="#http2sessionconnecting" id="http2sessionconnecting">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2session_connecting"></a></h5> 1040<div class="api_metadata"> 1041<span>Added in: v10.0.0</span> 1042</div> 1043<ul> 1044<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1045</ul> 1046<p>Will be <code>true</code> if this <code>Http2Session</code> instance is still connecting, will be set 1047to <code>false</code> before emitting <code>connect</code> event and/or calling the <code>http2.connect</code> 1048callback.</p> 1049<h5><code>http2session.destroy([error][, code])</code><span><a class="mark" href="#http2sessiondestroyerror-code" id="http2sessiondestroyerror-code">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2session_destroy_error_code"></a></h5> 1050<div class="api_metadata"> 1051<span>Added in: v8.4.0</span> 1052</div> 1053<ul> 1054<li><code>error</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" class="type"><Error></a> An <code>Error</code> object if the <code>Http2Session</code> is being destroyed 1055due to an error.</li> 1056<li><code>code</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The HTTP/2 error code to send in the final <code>GOAWAY</code> frame. 1057If unspecified, and <code>error</code> is not undefined, the default is <code>INTERNAL_ERROR</code>, 1058otherwise defaults to <code>NO_ERROR</code>.</li> 1059</ul> 1060<p>Immediately terminates the <code>Http2Session</code> and the associated <code>net.Socket</code> or 1061<code>tls.TLSSocket</code>.</p> 1062<p>Once destroyed, the <code>Http2Session</code> will emit the <code>'close'</code> event. If <code>error</code> 1063is not undefined, an <code>'error'</code> event will be emitted immediately before the 1064<code>'close'</code> event.</p> 1065<p>If there are any remaining open <code>Http2Streams</code> associated with the 1066<code>Http2Session</code>, those will also be destroyed.</p> 1067<h5><code>http2session.destroyed</code><span><a class="mark" href="#http2sessiondestroyed" id="http2sessiondestroyed">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2session_destroyed"></a></h5> 1068<div class="api_metadata"> 1069<span>Added in: v8.4.0</span> 1070</div> 1071<ul> 1072<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1073</ul> 1074<p>Will be <code>true</code> if this <code>Http2Session</code> instance has been destroyed and must no 1075longer be used, otherwise <code>false</code>.</p> 1076<h5><code>http2session.encrypted</code><span><a class="mark" href="#http2sessionencrypted" id="http2sessionencrypted">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2session_encrypted"></a></h5> 1077<div class="api_metadata"> 1078<span>Added in: v9.4.0</span> 1079</div> 1080<ul> 1081<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Undefined_type" class="type"><undefined></a></li> 1082</ul> 1083<p>Value is <code>undefined</code> if the <code>Http2Session</code> session socket has not yet been 1084connected, <code>true</code> if the <code>Http2Session</code> is connected with a <code>TLSSocket</code>, 1085and <code>false</code> if the <code>Http2Session</code> is connected to any other kind of socket 1086or stream.</p> 1087<h5><code>http2session.goaway([code[, lastStreamID[, opaqueData]]])</code><span><a class="mark" href="#http2sessiongoawaycode-laststreamid-opaquedata" id="http2sessiongoawaycode-laststreamid-opaquedata">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2session_goaway_code_laststreamid_opaquedata"></a></h5> 1088<div class="api_metadata"> 1089<span>Added in: v9.4.0</span> 1090</div> 1091<ul> 1092<li><code>code</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> An HTTP/2 error code</li> 1093<li><code>lastStreamID</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The numeric ID of the last processed <code>Http2Stream</code></li> 1094<li><code>opaqueData</code> <a href="buffer.html#class-buffer" class="type"><Buffer></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray" class="type"><TypedArray></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView" class="type"><DataView></a> A <code>TypedArray</code> or <code>DataView</code> 1095instance containing additional data to be carried within the <code>GOAWAY</code> frame.</li> 1096</ul> 1097<p>Transmits a <code>GOAWAY</code> frame to the connected peer <em>without</em> shutting down the 1098<code>Http2Session</code>.</p> 1099<h5><code>http2session.localSettings</code><span><a class="mark" href="#http2sessionlocalsettings" id="http2sessionlocalsettings">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2session_localsettings"></a></h5> 1100<div class="api_metadata"> 1101<span>Added in: v8.4.0</span> 1102</div> 1103<ul> 1104<li><a href="http2.html#settings-object" class="type"><HTTP/2 Settings Object></a></li> 1105</ul> 1106<p>A prototype-less object describing the current local settings of this 1107<code>Http2Session</code>. The local settings are local to <em>this</em> <code>Http2Session</code> instance.</p> 1108<h5><code>http2session.originSet</code><span><a class="mark" href="#http2sessionoriginset" id="http2sessionoriginset">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2session_originset"></a></h5> 1109<div class="api_metadata"> 1110<span>Added in: v9.4.0</span> 1111</div> 1112<ul> 1113<li><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> 1114</ul> 1115<p>If the <code>Http2Session</code> is connected to a <code>TLSSocket</code>, the <code>originSet</code> property 1116will return an <code>Array</code> of origins for which the <code>Http2Session</code> may be 1117considered authoritative.</p> 1118<p>The <code>originSet</code> property is only available when using a secure TLS connection.</p> 1119<h5><code>http2session.pendingSettingsAck</code><span><a class="mark" href="#http2sessionpendingsettingsack" id="http2sessionpendingsettingsack">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2session_pendingsettingsack"></a></h5> 1120<div class="api_metadata"> 1121<span>Added in: v8.4.0</span> 1122</div> 1123<ul> 1124<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1125</ul> 1126<p>Indicates whether the <code>Http2Session</code> is currently waiting for acknowledgment of 1127a sent <code>SETTINGS</code> frame. Will be <code>true</code> after calling the 1128<code>http2session.settings()</code> method. Will be <code>false</code> once all sent <code>SETTINGS</code> 1129frames have been acknowledged.</p> 1130<h5><code>http2session.ping([payload, ]callback)</code><span><a class="mark" href="#http2sessionpingpayload-callback" id="http2sessionpingpayload-callback">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2session_ping_payload_callback"></a></h5> 1131<div class="api_metadata"> 1132<details class="changelog"><summary>History</summary> 1133<table> 1134<tbody><tr><th>Version</th><th>Changes</th></tr> 1135<tr><td>v18.0.0</td> 1136<td><p>Passing an invalid callback to the <code>callback</code> argument now throws <code>ERR_INVALID_ARG_TYPE</code> instead of <code>ERR_INVALID_CALLBACK</code>.</p></td></tr> 1137<tr><td>v8.9.3</td> 1138<td><p><span>Added in: v8.9.3</span></p></td></tr> 1139</tbody></table> 1140</details> 1141</div> 1142<ul> 1143<li><code>payload</code> <a href="buffer.html#class-buffer" class="type"><Buffer></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray" class="type"><TypedArray></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView" class="type"><DataView></a> Optional ping payload.</li> 1144<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 1145<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1146</ul> 1147<p>Sends a <code>PING</code> frame to the connected HTTP/2 peer. A <code>callback</code> function must 1148be provided. The method will return <code>true</code> if the <code>PING</code> was sent, <code>false</code> 1149otherwise.</p> 1150<p>The maximum number of outstanding (unacknowledged) pings is determined by the 1151<code>maxOutstandingPings</code> configuration option. The default maximum is 10.</p> 1152<p>If provided, the <code>payload</code> must be a <code>Buffer</code>, <code>TypedArray</code>, or <code>DataView</code> 1153containing 8 bytes of data that will be transmitted with the <code>PING</code> and 1154returned with the ping acknowledgment.</p> 1155<p>The callback will be invoked with three arguments: an error argument that will 1156be <code>null</code> if the <code>PING</code> was successfully acknowledged, a <code>duration</code> argument 1157that reports the number of milliseconds elapsed since the ping was sent and the 1158acknowledgment was received, and a <code>Buffer</code> containing the 8-byte <code>PING</code> 1159payload.</p> 1160<pre><code class="language-js">session.<span class="hljs-title function_">ping</span>(<span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>(<span class="hljs-string">'abcdefgh'</span>), <span class="hljs-function">(<span class="hljs-params">err, duration, payload</span>) =></span> { 1161 <span class="hljs-keyword">if</span> (!err) { 1162 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">`Ping acknowledged in <span class="hljs-subst">${duration}</span> milliseconds`</span>); 1163 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">`With payload '<span class="hljs-subst">${payload.toString()}</span>'`</span>); 1164 } 1165});</code> <button class="copy-button">copy</button></pre> 1166<p>If the <code>payload</code> argument is not specified, the default payload will be the 116764-bit timestamp (little endian) marking the start of the <code>PING</code> duration.</p> 1168<h5><code>http2session.ref()</code><span><a class="mark" href="#http2sessionref" id="http2sessionref">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2session_ref"></a></h5> 1169<div class="api_metadata"> 1170<span>Added in: v9.4.0</span> 1171</div> 1172<p>Calls <a href="net.html#socketref"><code>ref()</code></a> on this <code>Http2Session</code> 1173instance's underlying <a href="net.html#class-netsocket"><code>net.Socket</code></a>.</p> 1174<h5><code>http2session.remoteSettings</code><span><a class="mark" href="#http2sessionremotesettings" id="http2sessionremotesettings">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2session_remotesettings"></a></h5> 1175<div class="api_metadata"> 1176<span>Added in: v8.4.0</span> 1177</div> 1178<ul> 1179<li><a href="http2.html#settings-object" class="type"><HTTP/2 Settings Object></a></li> 1180</ul> 1181<p>A prototype-less object describing the current remote settings of this 1182<code>Http2Session</code>. The remote settings are set by the <em>connected</em> HTTP/2 peer.</p> 1183<h5><code>http2session.setLocalWindowSize(windowSize)</code><span><a class="mark" href="#http2sessionsetlocalwindowsizewindowsize" id="http2sessionsetlocalwindowsizewindowsize">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2session_setlocalwindowsize_windowsize"></a></h5> 1184<div class="api_metadata"> 1185<span>Added in: v15.3.0, v14.18.0</span> 1186</div> 1187<ul> 1188<li><code>windowSize</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 1189</ul> 1190<p>Sets the local endpoint's window size. 1191The <code>windowSize</code> is the total window size to set, not 1192the delta.</p> 1193<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 1194 1195<span class="hljs-keyword">const</span> server = http2.<span class="hljs-title function_">createServer</span>(); 1196<span class="hljs-keyword">const</span> expectedWindowSize = <span class="hljs-number">2</span> ** <span class="hljs-number">20</span>; 1197server.<span class="hljs-title function_">on</span>(<span class="hljs-string">'connect'</span>, <span class="hljs-function">(<span class="hljs-params">session</span>) =></span> { 1198 1199 <span class="hljs-comment">// Set local window size to be 2 ** 20</span> 1200 session.<span class="hljs-title function_">setLocalWindowSize</span>(expectedWindowSize); 1201});</code> <button class="copy-button">copy</button></pre> 1202<h5><code>http2session.setTimeout(msecs, callback)</code><span><a class="mark" href="#http2sessionsettimeoutmsecs-callback" id="http2sessionsettimeoutmsecs-callback">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2session_settimeout_msecs_callback"></a></h5> 1203<div class="api_metadata"> 1204<details class="changelog"><summary>History</summary> 1205<table> 1206<tbody><tr><th>Version</th><th>Changes</th></tr> 1207<tr><td>v18.0.0</td> 1208<td><p>Passing an invalid callback to the <code>callback</code> argument now throws <code>ERR_INVALID_ARG_TYPE</code> instead of <code>ERR_INVALID_CALLBACK</code>.</p></td></tr> 1209<tr><td>v8.4.0</td> 1210<td><p><span>Added in: v8.4.0</span></p></td></tr> 1211</tbody></table> 1212</details> 1213</div> 1214<ul> 1215<li><code>msecs</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 1216<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 1217</ul> 1218<p>Used to set a callback function that is called when there is no activity on 1219the <code>Http2Session</code> after <code>msecs</code> milliseconds. The given <code>callback</code> is 1220registered as a listener on the <code>'timeout'</code> event.</p> 1221<h5><code>http2session.socket</code><span><a class="mark" href="#http2sessionsocket" id="http2sessionsocket">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2session_socket"></a></h5> 1222<div class="api_metadata"> 1223<span>Added in: v8.4.0</span> 1224</div> 1225<ul> 1226<li><a href="net.html#class-netsocket" class="type"><net.Socket></a> | <a href="tls.html#class-tlstlssocket" class="type"><tls.TLSSocket></a></li> 1227</ul> 1228<p>Returns a <code>Proxy</code> object that acts as a <code>net.Socket</code> (or <code>tls.TLSSocket</code>) but 1229limits available methods to ones safe to use with HTTP/2.</p> 1230<p><code>destroy</code>, <code>emit</code>, <code>end</code>, <code>pause</code>, <code>read</code>, <code>resume</code>, and <code>write</code> will throw 1231an error with code <code>ERR_HTTP2_NO_SOCKET_MANIPULATION</code>. See 1232<a href="#http2session-and-sockets"><code>Http2Session</code> and Sockets</a> for more information.</p> 1233<p><code>setTimeout</code> method will be called on this <code>Http2Session</code>.</p> 1234<p>All other interactions will be routed directly to the socket.</p> 1235<h5><code>http2session.state</code><span><a class="mark" href="#http2sessionstate" id="http2sessionstate">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2session_state"></a></h5> 1236<div class="api_metadata"> 1237<span>Added in: v8.4.0</span> 1238</div> 1239<p>Provides miscellaneous information about the current state of the 1240<code>Http2Session</code>.</p> 1241<ul> 1242<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 1243<ul> 1244<li><code>effectiveLocalWindowSize</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The current local (receive) 1245flow control window size for the <code>Http2Session</code>.</li> 1246<li><code>effectiveRecvDataLength</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The current number of bytes 1247that have been received since the last flow control <code>WINDOW_UPDATE</code>.</li> 1248<li><code>nextStreamID</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The numeric identifier to be used the 1249next time a new <code>Http2Stream</code> is created by this <code>Http2Session</code>.</li> 1250<li><code>localWindowSize</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The number of bytes that the remote peer can 1251send without receiving a <code>WINDOW_UPDATE</code>.</li> 1252<li><code>lastProcStreamID</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The numeric id of the <code>Http2Stream</code> 1253for which a <code>HEADERS</code> or <code>DATA</code> frame was most recently received.</li> 1254<li><code>remoteWindowSize</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The number of bytes that this <code>Http2Session</code> 1255may send without receiving a <code>WINDOW_UPDATE</code>.</li> 1256<li><code>outboundQueueSize</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The number of frames currently within the 1257outbound queue for this <code>Http2Session</code>.</li> 1258<li><code>deflateDynamicTableSize</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The current size in bytes of the 1259outbound header compression state table.</li> 1260<li><code>inflateDynamicTableSize</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The current size in bytes of the 1261inbound header compression state table.</li> 1262</ul> 1263</li> 1264</ul> 1265<p>An object describing the current status of this <code>Http2Session</code>.</p> 1266<h5><code>http2session.settings([settings][, callback])</code><span><a class="mark" href="#http2sessionsettingssettings-callback" id="http2sessionsettingssettings-callback">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2session_settings_settings_callback"></a></h5> 1267<div class="api_metadata"> 1268<details class="changelog"><summary>History</summary> 1269<table> 1270<tbody><tr><th>Version</th><th>Changes</th></tr> 1271<tr><td>v18.0.0</td> 1272<td><p>Passing an invalid callback to the <code>callback</code> argument now throws <code>ERR_INVALID_ARG_TYPE</code> instead of <code>ERR_INVALID_CALLBACK</code>.</p></td></tr> 1273<tr><td>v8.4.0</td> 1274<td><p><span>Added in: v8.4.0</span></p></td></tr> 1275</tbody></table> 1276</details> 1277</div> 1278<ul> 1279<li><code>settings</code> <a href="http2.html#settings-object" class="type"><HTTP/2 Settings Object></a></li> 1280<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> Callback that is called once the session is connected or 1281right away if the session is already connected. 1282<ul> 1283<li><code>err</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" class="type"><Error></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Null_type" class="type"><null></a></li> 1284<li><code>settings</code> <a href="http2.html#settings-object" class="type"><HTTP/2 Settings Object></a> The updated <code>settings</code> object.</li> 1285<li><code>duration</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><integer></a></li> 1286</ul> 1287</li> 1288</ul> 1289<p>Updates the current local settings for this <code>Http2Session</code> and sends a new 1290<code>SETTINGS</code> frame to the connected HTTP/2 peer.</p> 1291<p>Once called, the <code>http2session.pendingSettingsAck</code> property will be <code>true</code> 1292while the session is waiting for the remote peer to acknowledge the new 1293settings.</p> 1294<p>The new settings will not become effective until the <code>SETTINGS</code> acknowledgment 1295is received and the <code>'localSettings'</code> event is emitted. It is possible to send 1296multiple <code>SETTINGS</code> frames while acknowledgment is still pending.</p> 1297<h5><code>http2session.type</code><span><a class="mark" href="#http2sessiontype" id="http2sessiontype">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2session_type"></a></h5> 1298<div class="api_metadata"> 1299<span>Added in: v8.4.0</span> 1300</div> 1301<ul> 1302<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 1303</ul> 1304<p>The <code>http2session.type</code> will be equal to 1305<code>http2.constants.NGHTTP2_SESSION_SERVER</code> if this <code>Http2Session</code> instance is a 1306server, and <code>http2.constants.NGHTTP2_SESSION_CLIENT</code> if the instance is a 1307client.</p> 1308<h5><code>http2session.unref()</code><span><a class="mark" href="#http2sessionunref" id="http2sessionunref">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2session_unref"></a></h5> 1309<div class="api_metadata"> 1310<span>Added in: v9.4.0</span> 1311</div> 1312<p>Calls <a href="net.html#socketunref"><code>unref()</code></a> on this <code>Http2Session</code> 1313instance's underlying <a href="net.html#class-netsocket"><code>net.Socket</code></a>.</p> 1314<h4>Class: <code>ServerHttp2Session</code><span><a class="mark" href="#class-serverhttp2session" id="class-serverhttp2session">#</a></span><a aria-hidden="true" class="legacy" id="http2_class_serverhttp2session"></a></h4> 1315<div class="api_metadata"> 1316<span>Added in: v8.4.0</span> 1317</div> 1318<ul> 1319<li>Extends: <a href="http2.html#class-http2session" class="type"><Http2Session></a></li> 1320</ul> 1321<h5><code>serverhttp2session.altsvc(alt, originOrStream)</code><span><a class="mark" href="#serverhttp2sessionaltsvcalt-originorstream" id="serverhttp2sessionaltsvcalt-originorstream">#</a></span><a aria-hidden="true" class="legacy" id="http2_serverhttp2session_altsvc_alt_originorstream"></a></h5> 1322<div class="api_metadata"> 1323<span>Added in: v9.4.0</span> 1324</div> 1325<ul> 1326<li><code>alt</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> A description of the alternative service configuration as 1327defined by <a href="https://tools.ietf.org/html/rfc7838">RFC 7838</a>.</li> 1328<li><code>originOrStream</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> | <a href="url.html#the-whatwg-url-api" class="type"><URL></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> Either a URL string specifying 1329the origin (or an <code>Object</code> with an <code>origin</code> property) or the numeric 1330identifier of an active <code>Http2Stream</code> as given by the <code>http2stream.id</code> 1331property.</li> 1332</ul> 1333<p>Submits an <code>ALTSVC</code> frame (as defined by <a href="https://tools.ietf.org/html/rfc7838">RFC 7838</a>) to the connected client.</p> 1334<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 1335 1336<span class="hljs-keyword">const</span> server = http2.<span class="hljs-title function_">createServer</span>(); 1337server.<span class="hljs-title function_">on</span>(<span class="hljs-string">'session'</span>, <span class="hljs-function">(<span class="hljs-params">session</span>) =></span> { 1338 <span class="hljs-comment">// Set altsvc for origin https://example.org:80</span> 1339 session.<span class="hljs-title function_">altsvc</span>(<span class="hljs-string">'h2=":8000"'</span>, <span class="hljs-string">'https://example.org:80'</span>); 1340}); 1341 1342server.<span class="hljs-title function_">on</span>(<span class="hljs-string">'stream'</span>, <span class="hljs-function">(<span class="hljs-params">stream</span>) =></span> { 1343 <span class="hljs-comment">// Set altsvc for a specific stream</span> 1344 stream.<span class="hljs-property">session</span>.<span class="hljs-title function_">altsvc</span>(<span class="hljs-string">'h2=":8000"'</span>, stream.<span class="hljs-property">id</span>); 1345});</code> <button class="copy-button">copy</button></pre> 1346<p>Sending an <code>ALTSVC</code> frame with a specific stream ID indicates that the alternate 1347service is associated with the origin of the given <code>Http2Stream</code>.</p> 1348<p>The <code>alt</code> and origin string <em>must</em> contain only ASCII bytes and are 1349strictly interpreted as a sequence of ASCII bytes. The special value <code>'clear'</code> 1350may be passed to clear any previously set alternative service for a given 1351domain.</p> 1352<p>When a string is passed for the <code>originOrStream</code> argument, it will be parsed as 1353a URL and the origin will be derived. For instance, the origin for the 1354HTTP URL <code>'https://example.org/foo/bar'</code> is the ASCII string 1355<code>'https://example.org'</code>. An error will be thrown if either the given string 1356cannot be parsed as a URL or if a valid origin cannot be derived.</p> 1357<p>A <code>URL</code> object, or any object with an <code>origin</code> property, may be passed as 1358<code>originOrStream</code>, in which case the value of the <code>origin</code> property will be 1359used. The value of the <code>origin</code> property <em>must</em> be a properly serialized 1360ASCII origin.</p> 1361<h5>Specifying alternative services<span><a class="mark" href="#specifying-alternative-services" id="specifying-alternative-services">#</a></span><a aria-hidden="true" class="legacy" id="http2_specifying_alternative_services"></a></h5> 1362<p>The format of the <code>alt</code> parameter is strictly defined by <a href="https://tools.ietf.org/html/rfc7838">RFC 7838</a> as an 1363ASCII string containing a comma-delimited list of "alternative" protocols 1364associated with a specific host and port.</p> 1365<p>For example, the value <code>'h2="example.org:81"'</code> indicates that the HTTP/2 1366protocol is available on the host <code>'example.org'</code> on TCP/IP port 81. The 1367host and port <em>must</em> be contained within the quote (<code>"</code>) characters.</p> 1368<p>Multiple alternatives may be specified, for instance: <code>'h2="example.org:81", h2=":82"'</code>.</p> 1369<p>The protocol identifier (<code>'h2'</code> in the examples) may be any valid 1370<a href="https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids">ALPN Protocol ID</a>.</p> 1371<p>The syntax of these values is not validated by the Node.js implementation and 1372are passed through as provided by the user or received from the peer.</p> 1373<h5><code>serverhttp2session.origin(...origins)</code><span><a class="mark" href="#serverhttp2sessionoriginorigins" id="serverhttp2sessionoriginorigins">#</a></span><a aria-hidden="true" class="legacy" id="http2_serverhttp2session_origin_origins"></a></h5> 1374<div class="api_metadata"> 1375<span>Added in: v10.12.0</span> 1376</div> 1377<ul> 1378<li><code>origins</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> | <a href="url.html#the-whatwg-url-api" class="type"><URL></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> One or more URL Strings passed as 1379separate arguments.</li> 1380</ul> 1381<p>Submits an <code>ORIGIN</code> frame (as defined by <a href="https://tools.ietf.org/html/rfc8336">RFC 8336</a>) to the connected client 1382to advertise the set of origins for which the server is capable of providing 1383authoritative responses.</p> 1384<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 1385<span class="hljs-keyword">const</span> options = <span class="hljs-title function_">getSecureOptionsSomehow</span>(); 1386<span class="hljs-keyword">const</span> server = http2.<span class="hljs-title function_">createSecureServer</span>(options); 1387server.<span class="hljs-title function_">on</span>(<span class="hljs-string">'stream'</span>, <span class="hljs-function">(<span class="hljs-params">stream</span>) =></span> { 1388 stream.<span class="hljs-title function_">respond</span>(); 1389 stream.<span class="hljs-title function_">end</span>(<span class="hljs-string">'ok'</span>); 1390}); 1391server.<span class="hljs-title function_">on</span>(<span class="hljs-string">'session'</span>, <span class="hljs-function">(<span class="hljs-params">session</span>) =></span> { 1392 session.<span class="hljs-title function_">origin</span>(<span class="hljs-string">'https://example.com'</span>, <span class="hljs-string">'https://example.org'</span>); 1393});</code> <button class="copy-button">copy</button></pre> 1394<p>When a string is passed as an <code>origin</code>, it will be parsed as a URL and the 1395origin will be derived. For instance, the origin for the HTTP URL 1396<code>'https://example.org/foo/bar'</code> is the ASCII string 1397<code>'https://example.org'</code>. An error will be thrown if either the given string 1398cannot be parsed as a URL or if a valid origin cannot be derived.</p> 1399<p>A <code>URL</code> object, or any object with an <code>origin</code> property, may be passed as 1400an <code>origin</code>, in which case the value of the <code>origin</code> property will be 1401used. The value of the <code>origin</code> property <em>must</em> be a properly serialized 1402ASCII origin.</p> 1403<p>Alternatively, the <code>origins</code> option may be used when creating a new HTTP/2 1404server using the <code>http2.createSecureServer()</code> method:</p> 1405<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 1406<span class="hljs-keyword">const</span> options = <span class="hljs-title function_">getSecureOptionsSomehow</span>(); 1407options.<span class="hljs-property">origins</span> = [<span class="hljs-string">'https://example.com'</span>, <span class="hljs-string">'https://example.org'</span>]; 1408<span class="hljs-keyword">const</span> server = http2.<span class="hljs-title function_">createSecureServer</span>(options); 1409server.<span class="hljs-title function_">on</span>(<span class="hljs-string">'stream'</span>, <span class="hljs-function">(<span class="hljs-params">stream</span>) =></span> { 1410 stream.<span class="hljs-title function_">respond</span>(); 1411 stream.<span class="hljs-title function_">end</span>(<span class="hljs-string">'ok'</span>); 1412});</code> <button class="copy-button">copy</button></pre> 1413<h4>Class: <code>ClientHttp2Session</code><span><a class="mark" href="#class-clienthttp2session" id="class-clienthttp2session">#</a></span><a aria-hidden="true" class="legacy" id="http2_class_clienthttp2session"></a></h4> 1414<div class="api_metadata"> 1415<span>Added in: v8.4.0</span> 1416</div> 1417<ul> 1418<li>Extends: <a href="http2.html#class-http2session" class="type"><Http2Session></a></li> 1419</ul> 1420<h5>Event: <code>'altsvc'</code><span><a class="mark" href="#event-altsvc" id="event-altsvc">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_altsvc"></a></h5> 1421<div class="api_metadata"> 1422<span>Added in: v9.4.0</span> 1423</div> 1424<ul> 1425<li><code>alt</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 1426<li><code>origin</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 1427<li><code>streamId</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 1428</ul> 1429<p>The <code>'altsvc'</code> event is emitted whenever an <code>ALTSVC</code> frame is received by 1430the client. The event is emitted with the <code>ALTSVC</code> value, origin, and stream 1431ID. If no <code>origin</code> is provided in the <code>ALTSVC</code> frame, <code>origin</code> will 1432be an empty string.</p> 1433<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 1434<span class="hljs-keyword">const</span> client = http2.<span class="hljs-title function_">connect</span>(<span class="hljs-string">'https://example.org'</span>); 1435 1436client.<span class="hljs-title function_">on</span>(<span class="hljs-string">'altsvc'</span>, <span class="hljs-function">(<span class="hljs-params">alt, origin, streamId</span>) =></span> { 1437 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(alt); 1438 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(origin); 1439 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(streamId); 1440});</code> <button class="copy-button">copy</button></pre> 1441<h5>Event: <code>'origin'</code><span><a class="mark" href="#event-origin" id="event-origin">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_origin"></a></h5> 1442<div class="api_metadata"> 1443<span>Added in: v10.12.0</span> 1444</div> 1445<ul> 1446<li><code>origins</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string[]></a></li> 1447</ul> 1448<p>The <code>'origin'</code> event is emitted whenever an <code>ORIGIN</code> frame is received by 1449the client. The event is emitted with an array of <code>origin</code> strings. The 1450<code>http2session.originSet</code> will be updated to include the received 1451origins.</p> 1452<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 1453<span class="hljs-keyword">const</span> client = http2.<span class="hljs-title function_">connect</span>(<span class="hljs-string">'https://example.org'</span>); 1454 1455client.<span class="hljs-title function_">on</span>(<span class="hljs-string">'origin'</span>, <span class="hljs-function">(<span class="hljs-params">origins</span>) =></span> { 1456 <span class="hljs-keyword">for</span> (<span class="hljs-keyword">let</span> n = <span class="hljs-number">0</span>; n < origins.<span class="hljs-property">length</span>; n++) 1457 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(origins[n]); 1458});</code> <button class="copy-button">copy</button></pre> 1459<p>The <code>'origin'</code> event is only emitted when using a secure TLS connection.</p> 1460<h5><code>clienthttp2session.request(headers[, options])</code><span><a class="mark" href="#clienthttp2sessionrequestheaders-options" id="clienthttp2sessionrequestheaders-options">#</a></span><a aria-hidden="true" class="legacy" id="http2_clienthttp2session_request_headers_options"></a></h5> 1461<div class="api_metadata"> 1462<span>Added in: v8.4.0</span> 1463</div> 1464<ul> 1465<li> 1466<p><code>headers</code> <a href="http2.html#headers-object" class="type"><HTTP/2 Headers Object></a></p> 1467</li> 1468<li> 1469<p><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></p> 1470<ul> 1471<li><code>endStream</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> <code>true</code> if the <code>Http2Stream</code> <em>writable</em> side should 1472be closed initially, such as when sending a <code>GET</code> request that should not 1473expect a payload body.</li> 1474<li><code>exclusive</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> When <code>true</code> and <code>parent</code> identifies a parent Stream, 1475the created stream is made the sole direct dependency of the parent, with 1476all other existing dependents made a dependent of the newly created stream. 1477<strong>Default:</strong> <code>false</code>.</li> 1478<li><code>parent</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Specifies the numeric identifier of a stream the newly 1479created stream is dependent on.</li> 1480<li><code>weight</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Specifies the relative dependency of a stream in relation 1481to other streams with the same <code>parent</code>. The value is a number between <code>1</code> 1482and <code>256</code> (inclusive).</li> 1483<li><code>waitForTrailers</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> When <code>true</code>, the <code>Http2Stream</code> will emit the 1484<code>'wantTrailers'</code> event after the final <code>DATA</code> frame has been sent.</li> 1485<li><code>signal</code> <a href="globals.html#class-abortsignal" class="type"><AbortSignal></a> An AbortSignal that may be used to abort an ongoing 1486request.</li> 1487</ul> 1488</li> 1489<li> 1490<p>Returns: <a href="http2.html#class-clienthttp2stream" class="type"><ClientHttp2Stream></a></p> 1491</li> 1492</ul> 1493<p>For HTTP/2 Client <code>Http2Session</code> instances only, the <code>http2session.request()</code> 1494creates and returns an <code>Http2Stream</code> instance that can be used to send an 1495HTTP/2 request to the connected server.</p> 1496<p>When a <code>ClientHttp2Session</code> is first created, the socket may not yet be 1497connected. if <code>clienthttp2session.request()</code> is called during this time, the 1498actual request will be deferred until the socket is ready to go. 1499If the <code>session</code> is closed before the actual request be executed, an 1500<code>ERR_HTTP2_GOAWAY_SESSION</code> is thrown.</p> 1501<p>This method is only available if <code>http2session.type</code> is equal to 1502<code>http2.constants.NGHTTP2_SESSION_CLIENT</code>.</p> 1503<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 1504<span class="hljs-keyword">const</span> clientSession = http2.<span class="hljs-title function_">connect</span>(<span class="hljs-string">'https://localhost:1234'</span>); 1505<span class="hljs-keyword">const</span> { 1506 <span class="hljs-title class_">HTTP2</span>_HEADER_PATH, 1507 <span class="hljs-title class_">HTTP2</span>_HEADER_STATUS, 1508} = http2.<span class="hljs-property">constants</span>; 1509 1510<span class="hljs-keyword">const</span> req = clientSession.<span class="hljs-title function_">request</span>({ [<span class="hljs-title class_">HTTP2</span>_HEADER_PATH]: <span class="hljs-string">'/'</span> }); 1511req.<span class="hljs-title function_">on</span>(<span class="hljs-string">'response'</span>, <span class="hljs-function">(<span class="hljs-params">headers</span>) =></span> { 1512 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(headers[<span class="hljs-title class_">HTTP2</span>_HEADER_STATUS]); 1513 req.<span class="hljs-title function_">on</span>(<span class="hljs-string">'data'</span>, <span class="hljs-function">(<span class="hljs-params">chunk</span>) =></span> { <span class="hljs-comment">/* .. */</span> }); 1514 req.<span class="hljs-title function_">on</span>(<span class="hljs-string">'end'</span>, <span class="hljs-function">() =></span> { <span class="hljs-comment">/* .. */</span> }); 1515});</code> <button class="copy-button">copy</button></pre> 1516<p>When the <code>options.waitForTrailers</code> option is set, the <code>'wantTrailers'</code> event 1517is emitted immediately after queuing the last chunk of payload data to be sent. 1518The <code>http2stream.sendTrailers()</code> method can then be called to send trailing 1519headers to the peer.</p> 1520<p>When <code>options.waitForTrailers</code> is set, the <code>Http2Stream</code> will not automatically 1521close when the final <code>DATA</code> frame is transmitted. User code must call either 1522<code>http2stream.sendTrailers()</code> or <code>http2stream.close()</code> to close the 1523<code>Http2Stream</code>.</p> 1524<p>When <code>options.signal</code> is set with an <code>AbortSignal</code> and then <code>abort</code> on the 1525corresponding <code>AbortController</code> is called, the request will emit an <code>'error'</code> 1526event with an <code>AbortError</code> error.</p> 1527<p>The <code>:method</code> and <code>:path</code> pseudo-headers are not specified within <code>headers</code>, 1528they respectively default to:</p> 1529<ul> 1530<li><code>:method</code> = <code>'GET'</code></li> 1531<li><code>:path</code> = <code>/</code></li> 1532</ul> 1533<h4>Class: <code>Http2Stream</code><span><a class="mark" href="#class-http2stream" id="class-http2stream">#</a></span><a aria-hidden="true" class="legacy" id="http2_class_http2stream"></a></h4> 1534<div class="api_metadata"> 1535<span>Added in: v8.4.0</span> 1536</div> 1537<ul> 1538<li>Extends: <a href="stream.html#class-streamduplex" class="type"><stream.Duplex></a></li> 1539</ul> 1540<p>Each instance of the <code>Http2Stream</code> class represents a bidirectional HTTP/2 1541communications stream over an <code>Http2Session</code> instance. Any single <code>Http2Session</code> 1542may have up to 2<sup>31</sup>-1 <code>Http2Stream</code> instances over its lifetime.</p> 1543<p>User code will not construct <code>Http2Stream</code> instances directly. Rather, these 1544are created, managed, and provided to user code through the <code>Http2Session</code> 1545instance. On the server, <code>Http2Stream</code> instances are created either in response 1546to an incoming HTTP request (and handed off to user code via the <code>'stream'</code> 1547event), or in response to a call to the <code>http2stream.pushStream()</code> method. 1548On the client, <code>Http2Stream</code> instances are created and returned when either the 1549<code>http2session.request()</code> method is called, or in response to an incoming 1550<code>'push'</code> event.</p> 1551<p>The <code>Http2Stream</code> class is a base for the <a href="#class-serverhttp2stream"><code>ServerHttp2Stream</code></a> and 1552<a href="#class-clienthttp2stream"><code>ClientHttp2Stream</code></a> classes, each of which is used specifically by either 1553the Server or Client side, respectively.</p> 1554<p>All <code>Http2Stream</code> instances are <a href="stream.html#class-streamduplex"><code>Duplex</code></a> streams. The <code>Writable</code> side of the 1555<code>Duplex</code> is used to send data to the connected peer, while the <code>Readable</code> side 1556is used to receive data sent by the connected peer.</p> 1557<p>The default text character encoding for an <code>Http2Stream</code> is UTF-8. When using an 1558<code>Http2Stream</code> to send text, use the <code>'content-type'</code> header to set the character 1559encoding.</p> 1560<pre><code class="language-js">stream.<span class="hljs-title function_">respond</span>({ 1561 <span class="hljs-string">'content-type'</span>: <span class="hljs-string">'text/html; charset=utf-8'</span>, 1562 <span class="hljs-string">':status'</span>: <span class="hljs-number">200</span>, 1563});</code> <button class="copy-button">copy</button></pre> 1564<h5><code>Http2Stream</code> Lifecycle<span><a class="mark" href="#http2stream-lifecycle" id="http2stream-lifecycle">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2stream_lifecycle"></a></h5> 1565<h6>Creation<span><a class="mark" href="#creation" id="creation">#</a></span><a aria-hidden="true" class="legacy" id="http2_creation"></a></h6> 1566<p>On the server side, instances of <a href="#class-serverhttp2stream"><code>ServerHttp2Stream</code></a> are created either 1567when:</p> 1568<ul> 1569<li>A new HTTP/2 <code>HEADERS</code> frame with a previously unused stream ID is received;</li> 1570<li>The <code>http2stream.pushStream()</code> method is called.</li> 1571</ul> 1572<p>On the client side, instances of <a href="#class-clienthttp2stream"><code>ClientHttp2Stream</code></a> are created when the 1573<code>http2session.request()</code> method is called.</p> 1574<p>On the client, the <code>Http2Stream</code> instance returned by <code>http2session.request()</code> 1575may not be immediately ready for use if the parent <code>Http2Session</code> has not yet 1576been fully established. In such cases, operations called on the <code>Http2Stream</code> 1577will be buffered until the <code>'ready'</code> event is emitted. User code should rarely, 1578if ever, need to handle the <code>'ready'</code> event directly. The ready status of an 1579<code>Http2Stream</code> can be determined by checking the value of <code>http2stream.id</code>. If 1580the value is <code>undefined</code>, the stream is not yet ready for use.</p> 1581<h6>Destruction<span><a class="mark" href="#destruction" id="destruction">#</a></span><a aria-hidden="true" class="legacy" id="http2_destruction"></a></h6> 1582<p>All <a href="#class-http2stream"><code>Http2Stream</code></a> instances are destroyed either when:</p> 1583<ul> 1584<li>An <code>RST_STREAM</code> frame for the stream is received by the connected peer, 1585and (for client streams only) pending data has been read.</li> 1586<li>The <code>http2stream.close()</code> method is called, and (for client streams only) 1587pending data has been read.</li> 1588<li>The <code>http2stream.destroy()</code> or <code>http2session.destroy()</code> methods are called.</li> 1589</ul> 1590<p>When an <code>Http2Stream</code> instance is destroyed, an attempt will be made to send an 1591<code>RST_STREAM</code> frame to the connected peer.</p> 1592<p>When the <code>Http2Stream</code> instance is destroyed, the <code>'close'</code> event will 1593be emitted. Because <code>Http2Stream</code> is an instance of <code>stream.Duplex</code>, the 1594<code>'end'</code> event will also be emitted if the stream data is currently flowing. 1595The <code>'error'</code> event may also be emitted if <code>http2stream.destroy()</code> was called 1596with an <code>Error</code> passed as the first argument.</p> 1597<p>After the <code>Http2Stream</code> has been destroyed, the <code>http2stream.destroyed</code> 1598property will be <code>true</code> and the <code>http2stream.rstCode</code> property will specify the 1599<code>RST_STREAM</code> error code. The <code>Http2Stream</code> instance is no longer usable once 1600destroyed.</p> 1601<h5>Event: <code>'aborted'</code><span><a class="mark" href="#event-aborted" id="event-aborted">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_aborted"></a></h5> 1602<div class="api_metadata"> 1603<span>Added in: v8.4.0</span> 1604</div> 1605<p>The <code>'aborted'</code> event is emitted whenever a <code>Http2Stream</code> instance is 1606abnormally aborted in mid-communication. 1607Its listener does not expect any arguments.</p> 1608<p>The <code>'aborted'</code> event will only be emitted if the <code>Http2Stream</code> writable side 1609has not been ended.</p> 1610<h5>Event: <code>'close'</code><span><a class="mark" href="#event-close_1" id="event-close_1">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_close_1"></a></h5> 1611<div class="api_metadata"> 1612<span>Added in: v8.4.0</span> 1613</div> 1614<p>The <code>'close'</code> event is emitted when the <code>Http2Stream</code> is destroyed. Once 1615this event is emitted, the <code>Http2Stream</code> instance is no longer usable.</p> 1616<p>The HTTP/2 error code used when closing the stream can be retrieved using 1617the <code>http2stream.rstCode</code> property. If the code is any value other than 1618<code>NGHTTP2_NO_ERROR</code> (<code>0</code>), an <code>'error'</code> event will have also been emitted.</p> 1619<h5>Event: <code>'error'</code><span><a class="mark" href="#event-error_1" id="event-error_1">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_error_1"></a></h5> 1620<div class="api_metadata"> 1621<span>Added in: v8.4.0</span> 1622</div> 1623<ul> 1624<li><code>error</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" class="type"><Error></a></li> 1625</ul> 1626<p>The <code>'error'</code> event is emitted when an error occurs during the processing of 1627an <code>Http2Stream</code>.</p> 1628<h5>Event: <code>'frameError'</code><span><a class="mark" href="#event-frameerror_1" id="event-frameerror_1">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_frameerror_1"></a></h5> 1629<div class="api_metadata"> 1630<span>Added in: v8.4.0</span> 1631</div> 1632<ul> 1633<li><code>type</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><integer></a> The frame type.</li> 1634<li><code>code</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><integer></a> The error code.</li> 1635<li><code>id</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><integer></a> The stream id (or <code>0</code> if the frame isn't associated with a 1636stream).</li> 1637</ul> 1638<p>The <code>'frameError'</code> event is emitted when an error occurs while attempting to 1639send a frame. When invoked, the handler function will receive an integer 1640argument identifying the frame type, and an integer argument identifying the 1641error code. The <code>Http2Stream</code> instance will be destroyed immediately after the 1642<code>'frameError'</code> event is emitted.</p> 1643<h5>Event: <code>'ready'</code><span><a class="mark" href="#event-ready" id="event-ready">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_ready"></a></h5> 1644<div class="api_metadata"> 1645<span>Added in: v8.4.0</span> 1646</div> 1647<p>The <code>'ready'</code> event is emitted when the <code>Http2Stream</code> has been opened, has 1648been assigned an <code>id</code>, and can be used. The listener does not expect any 1649arguments.</p> 1650<h5>Event: <code>'timeout'</code><span><a class="mark" href="#event-timeout_1" id="event-timeout_1">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_timeout_1"></a></h5> 1651<div class="api_metadata"> 1652<span>Added in: v8.4.0</span> 1653</div> 1654<p>The <code>'timeout'</code> event is emitted after no activity is received for this 1655<code>Http2Stream</code> within the number of milliseconds set using 1656<code>http2stream.setTimeout()</code>. 1657Its listener does not expect any arguments.</p> 1658<h5>Event: <code>'trailers'</code><span><a class="mark" href="#event-trailers" id="event-trailers">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_trailers"></a></h5> 1659<div class="api_metadata"> 1660<span>Added in: v8.4.0</span> 1661</div> 1662<ul> 1663<li><code>headers</code> <a href="http2.html#headers-object" class="type"><HTTP/2 Headers Object></a> An object describing the headers</li> 1664<li><code>flags</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The associated numeric flags</li> 1665</ul> 1666<p>The <code>'trailers'</code> event is emitted when a block of headers associated with 1667trailing header fields is received. The listener callback is passed the 1668<a href="#headers-object">HTTP/2 Headers Object</a> and flags associated with the headers.</p> 1669<p>This event might not be emitted if <code>http2stream.end()</code> is called 1670before trailers are received and the incoming data is not being read or 1671listened for.</p> 1672<pre><code class="language-js">stream.<span class="hljs-title function_">on</span>(<span class="hljs-string">'trailers'</span>, <span class="hljs-function">(<span class="hljs-params">headers, flags</span>) =></span> { 1673 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(headers); 1674});</code> <button class="copy-button">copy</button></pre> 1675<h5>Event: <code>'wantTrailers'</code><span><a class="mark" href="#event-wanttrailers" id="event-wanttrailers">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_wanttrailers"></a></h5> 1676<div class="api_metadata"> 1677<span>Added in: v10.0.0</span> 1678</div> 1679<p>The <code>'wantTrailers'</code> event is emitted when the <code>Http2Stream</code> has queued the 1680final <code>DATA</code> frame to be sent on a frame and the <code>Http2Stream</code> is ready to send 1681trailing headers. When initiating a request or response, the <code>waitForTrailers</code> 1682option must be set for this event to be emitted.</p> 1683<h5><code>http2stream.aborted</code><span><a class="mark" href="#http2streamaborted" id="http2streamaborted">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2stream_aborted"></a></h5> 1684<div class="api_metadata"> 1685<span>Added in: v8.4.0</span> 1686</div> 1687<ul> 1688<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1689</ul> 1690<p>Set to <code>true</code> if the <code>Http2Stream</code> instance was aborted abnormally. When set, 1691the <code>'aborted'</code> event will have been emitted.</p> 1692<h5><code>http2stream.bufferSize</code><span><a class="mark" href="#http2streambuffersize" id="http2streambuffersize">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2stream_buffersize"></a></h5> 1693<div class="api_metadata"> 1694<span>Added in: v11.2.0, v10.16.0</span> 1695</div> 1696<ul> 1697<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 1698</ul> 1699<p>This property shows the number of characters currently buffered to be written. 1700See <a href="net.html#socketbuffersize"><code>net.Socket.bufferSize</code></a> for details.</p> 1701<h5><code>http2stream.close(code[, callback])</code><span><a class="mark" href="#http2streamclosecode-callback" id="http2streamclosecode-callback">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2stream_close_code_callback"></a></h5> 1702<div class="api_metadata"> 1703<details class="changelog"><summary>History</summary> 1704<table> 1705<tbody><tr><th>Version</th><th>Changes</th></tr> 1706<tr><td>v18.0.0</td> 1707<td><p>Passing an invalid callback to the <code>callback</code> argument now throws <code>ERR_INVALID_ARG_TYPE</code> instead of <code>ERR_INVALID_CALLBACK</code>.</p></td></tr> 1708<tr><td>v8.4.0</td> 1709<td><p><span>Added in: v8.4.0</span></p></td></tr> 1710</tbody></table> 1711</details> 1712</div> 1713<ul> 1714<li><code>code</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Unsigned 32-bit integer identifying the error code. 1715<strong>Default:</strong> <code>http2.constants.NGHTTP2_NO_ERROR</code> (<code>0x00</code>).</li> 1716<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> An optional function registered to listen for the 1717<code>'close'</code> event.</li> 1718</ul> 1719<p>Closes the <code>Http2Stream</code> instance by sending an <code>RST_STREAM</code> frame to the 1720connected HTTP/2 peer.</p> 1721<h5><code>http2stream.closed</code><span><a class="mark" href="#http2streamclosed" id="http2streamclosed">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2stream_closed"></a></h5> 1722<div class="api_metadata"> 1723<span>Added in: v9.4.0</span> 1724</div> 1725<ul> 1726<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1727</ul> 1728<p>Set to <code>true</code> if the <code>Http2Stream</code> instance has been closed.</p> 1729<h5><code>http2stream.destroyed</code><span><a class="mark" href="#http2streamdestroyed" id="http2streamdestroyed">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2stream_destroyed"></a></h5> 1730<div class="api_metadata"> 1731<span>Added in: v8.4.0</span> 1732</div> 1733<ul> 1734<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1735</ul> 1736<p>Set to <code>true</code> if the <code>Http2Stream</code> instance has been destroyed and is no longer 1737usable.</p> 1738<h5><code>http2stream.endAfterHeaders</code><span><a class="mark" href="#http2streamendafterheaders" id="http2streamendafterheaders">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2stream_endafterheaders"></a></h5> 1739<div class="api_metadata"> 1740<span>Added in: v10.11.0</span> 1741</div> 1742<ul> 1743<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1744</ul> 1745<p>Set to <code>true</code> if the <code>END_STREAM</code> flag was set in the request or response 1746HEADERS frame received, indicating that no additional data should be received 1747and the readable side of the <code>Http2Stream</code> will be closed.</p> 1748<h5><code>http2stream.id</code><span><a class="mark" href="#http2streamid" id="http2streamid">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2stream_id"></a></h5> 1749<div class="api_metadata"> 1750<span>Added in: v8.4.0</span> 1751</div> 1752<ul> 1753<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Undefined_type" class="type"><undefined></a></li> 1754</ul> 1755<p>The numeric stream identifier of this <code>Http2Stream</code> instance. Set to <code>undefined</code> 1756if the stream identifier has not yet been assigned.</p> 1757<h5><code>http2stream.pending</code><span><a class="mark" href="#http2streampending" id="http2streampending">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2stream_pending"></a></h5> 1758<div class="api_metadata"> 1759<span>Added in: v9.4.0</span> 1760</div> 1761<ul> 1762<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1763</ul> 1764<p>Set to <code>true</code> if the <code>Http2Stream</code> instance has not yet been assigned a 1765numeric stream identifier.</p> 1766<h5><code>http2stream.priority(options)</code><span><a class="mark" href="#http2streampriorityoptions" id="http2streampriorityoptions">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2stream_priority_options"></a></h5> 1767<div class="api_metadata"> 1768<span>Added in: v8.4.0</span> 1769</div> 1770<ul> 1771<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 1772<ul> 1773<li><code>exclusive</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> When <code>true</code> and <code>parent</code> identifies a parent Stream, 1774this stream is made the sole direct dependency of the parent, with 1775all other existing dependents made a dependent of this stream. <strong>Default:</strong> 1776<code>false</code>.</li> 1777<li><code>parent</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Specifies the numeric identifier of a stream this stream 1778is dependent on.</li> 1779<li><code>weight</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Specifies the relative dependency of a stream in relation 1780to other streams with the same <code>parent</code>. The value is a number between <code>1</code> 1781and <code>256</code> (inclusive).</li> 1782<li><code>silent</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> When <code>true</code>, changes the priority locally without 1783sending a <code>PRIORITY</code> frame to the connected peer.</li> 1784</ul> 1785</li> 1786</ul> 1787<p>Updates the priority for this <code>Http2Stream</code> instance.</p> 1788<h5><code>http2stream.rstCode</code><span><a class="mark" href="#http2streamrstcode" id="http2streamrstcode">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2stream_rstcode"></a></h5> 1789<div class="api_metadata"> 1790<span>Added in: v8.4.0</span> 1791</div> 1792<ul> 1793<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 1794</ul> 1795<p>Set to the <code>RST_STREAM</code> <a href="#error-codes-for-rst_stream-and-goaway">error code</a> reported when the <code>Http2Stream</code> is 1796destroyed after either receiving an <code>RST_STREAM</code> frame from the connected peer, 1797calling <code>http2stream.close()</code>, or <code>http2stream.destroy()</code>. Will be 1798<code>undefined</code> if the <code>Http2Stream</code> has not been closed.</p> 1799<h5><code>http2stream.sentHeaders</code><span><a class="mark" href="#http2streamsentheaders" id="http2streamsentheaders">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2stream_sentheaders"></a></h5> 1800<div class="api_metadata"> 1801<span>Added in: v9.5.0</span> 1802</div> 1803<ul> 1804<li><a href="http2.html#headers-object" class="type"><HTTP/2 Headers Object></a></li> 1805</ul> 1806<p>An object containing the outbound headers sent for this <code>Http2Stream</code>.</p> 1807<h5><code>http2stream.sentInfoHeaders</code><span><a class="mark" href="#http2streamsentinfoheaders" id="http2streamsentinfoheaders">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2stream_sentinfoheaders"></a></h5> 1808<div class="api_metadata"> 1809<span>Added in: v9.5.0</span> 1810</div> 1811<ul> 1812<li><a href="http2.html#headers-object" class="type"><HTTP/2 Headers Object[]></a></li> 1813</ul> 1814<p>An array of objects containing the outbound informational (additional) headers 1815sent for this <code>Http2Stream</code>.</p> 1816<h5><code>http2stream.sentTrailers</code><span><a class="mark" href="#http2streamsenttrailers" id="http2streamsenttrailers">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2stream_senttrailers"></a></h5> 1817<div class="api_metadata"> 1818<span>Added in: v9.5.0</span> 1819</div> 1820<ul> 1821<li><a href="http2.html#headers-object" class="type"><HTTP/2 Headers Object></a></li> 1822</ul> 1823<p>An object containing the outbound trailers sent for this <code>HttpStream</code>.</p> 1824<h5><code>http2stream.session</code><span><a class="mark" href="#http2streamsession" id="http2streamsession">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2stream_session"></a></h5> 1825<div class="api_metadata"> 1826<span>Added in: v8.4.0</span> 1827</div> 1828<ul> 1829<li><a href="http2.html#class-http2session" class="type"><Http2Session></a></li> 1830</ul> 1831<p>A reference to the <code>Http2Session</code> instance that owns this <code>Http2Stream</code>. The 1832value will be <code>undefined</code> after the <code>Http2Stream</code> instance is destroyed.</p> 1833<h5><code>http2stream.setTimeout(msecs, callback)</code><span><a class="mark" href="#http2streamsettimeoutmsecs-callback" id="http2streamsettimeoutmsecs-callback">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2stream_settimeout_msecs_callback"></a></h5> 1834<div class="api_metadata"> 1835<details class="changelog"><summary>History</summary> 1836<table> 1837<tbody><tr><th>Version</th><th>Changes</th></tr> 1838<tr><td>v18.0.0</td> 1839<td><p>Passing an invalid callback to the <code>callback</code> argument now throws <code>ERR_INVALID_ARG_TYPE</code> instead of <code>ERR_INVALID_CALLBACK</code>.</p></td></tr> 1840<tr><td>v8.4.0</td> 1841<td><p><span>Added in: v8.4.0</span></p></td></tr> 1842</tbody></table> 1843</details> 1844</div> 1845<ul> 1846<li><code>msecs</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 1847<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 1848</ul> 1849<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 1850<span class="hljs-keyword">const</span> client = http2.<span class="hljs-title function_">connect</span>(<span class="hljs-string">'http://example.org:8000'</span>); 1851<span class="hljs-keyword">const</span> { <span class="hljs-title class_">NGHTTP2</span>_CANCEL } = http2.<span class="hljs-property">constants</span>; 1852<span class="hljs-keyword">const</span> req = client.<span class="hljs-title function_">request</span>({ <span class="hljs-string">':path'</span>: <span class="hljs-string">'/'</span> }); 1853 1854<span class="hljs-comment">// Cancel the stream if there's no activity after 5 seconds</span> 1855req.<span class="hljs-built_in">setTimeout</span>(<span class="hljs-number">5000</span>, <span class="hljs-function">() =></span> req.<span class="hljs-title function_">close</span>(<span class="hljs-title class_">NGHTTP2</span>_CANCEL));</code> <button class="copy-button">copy</button></pre> 1856<h5><code>http2stream.state</code><span><a class="mark" href="#http2streamstate" id="http2streamstate">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2stream_state"></a></h5> 1857<div class="api_metadata"> 1858<span>Added in: v8.4.0</span> 1859</div> 1860<p>Provides miscellaneous information about the current state of the 1861<code>Http2Stream</code>.</p> 1862<ul> 1863<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 1864<ul> 1865<li><code>localWindowSize</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The number of bytes the connected peer may send 1866for this <code>Http2Stream</code> without receiving a <code>WINDOW_UPDATE</code>.</li> 1867<li><code>state</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> A flag indicating the low-level current state of the 1868<code>Http2Stream</code> as determined by <code>nghttp2</code>.</li> 1869<li><code>localClose</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> <code>1</code> if this <code>Http2Stream</code> has been closed locally.</li> 1870<li><code>remoteClose</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> <code>1</code> if this <code>Http2Stream</code> has been closed 1871remotely.</li> 1872<li><code>sumDependencyWeight</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The sum weight of all <code>Http2Stream</code> 1873instances that depend on this <code>Http2Stream</code> as specified using 1874<code>PRIORITY</code> frames.</li> 1875<li><code>weight</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The priority weight of this <code>Http2Stream</code>.</li> 1876</ul> 1877</li> 1878</ul> 1879<p>A current state of this <code>Http2Stream</code>.</p> 1880<h5><code>http2stream.sendTrailers(headers)</code><span><a class="mark" href="#http2streamsendtrailersheaders" id="http2streamsendtrailersheaders">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2stream_sendtrailers_headers"></a></h5> 1881<div class="api_metadata"> 1882<span>Added in: v10.0.0</span> 1883</div> 1884<ul> 1885<li><code>headers</code> <a href="http2.html#headers-object" class="type"><HTTP/2 Headers Object></a></li> 1886</ul> 1887<p>Sends a trailing <code>HEADERS</code> frame to the connected HTTP/2 peer. This method 1888will cause the <code>Http2Stream</code> to be immediately closed and must only be 1889called after the <code>'wantTrailers'</code> event has been emitted. When sending a 1890request or sending a response, the <code>options.waitForTrailers</code> option must be set 1891in order to keep the <code>Http2Stream</code> open after the final <code>DATA</code> frame so that 1892trailers can be sent.</p> 1893<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 1894<span class="hljs-keyword">const</span> server = http2.<span class="hljs-title function_">createServer</span>(); 1895server.<span class="hljs-title function_">on</span>(<span class="hljs-string">'stream'</span>, <span class="hljs-function">(<span class="hljs-params">stream</span>) =></span> { 1896 stream.<span class="hljs-title function_">respond</span>(<span class="hljs-literal">undefined</span>, { <span class="hljs-attr">waitForTrailers</span>: <span class="hljs-literal">true</span> }); 1897 stream.<span class="hljs-title function_">on</span>(<span class="hljs-string">'wantTrailers'</span>, <span class="hljs-function">() =></span> { 1898 stream.<span class="hljs-title function_">sendTrailers</span>({ <span class="hljs-attr">xyz</span>: <span class="hljs-string">'abc'</span> }); 1899 }); 1900 stream.<span class="hljs-title function_">end</span>(<span class="hljs-string">'Hello World'</span>); 1901});</code> <button class="copy-button">copy</button></pre> 1902<p>The HTTP/1 specification forbids trailers from containing HTTP/2 pseudo-header 1903fields (e.g. <code>':method'</code>, <code>':path'</code>, etc).</p> 1904<h4>Class: <code>ClientHttp2Stream</code><span><a class="mark" href="#class-clienthttp2stream" id="class-clienthttp2stream">#</a></span><a aria-hidden="true" class="legacy" id="http2_class_clienthttp2stream"></a></h4> 1905<div class="api_metadata"> 1906<span>Added in: v8.4.0</span> 1907</div> 1908<ul> 1909<li>Extends <a href="http2.html#class-http2stream" class="type"><Http2Stream></a></li> 1910</ul> 1911<p>The <code>ClientHttp2Stream</code> class is an extension of <code>Http2Stream</code> that is 1912used exclusively on HTTP/2 Clients. <code>Http2Stream</code> instances on the client 1913provide events such as <code>'response'</code> and <code>'push'</code> that are only relevant on 1914the client.</p> 1915<h5>Event: <code>'continue'</code><span><a class="mark" href="#event-continue" id="event-continue">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_continue"></a></h5> 1916<div class="api_metadata"> 1917<span>Added in: v8.5.0</span> 1918</div> 1919<p>Emitted when the server sends a <code>100 Continue</code> status, usually because 1920the request contained <code>Expect: 100-continue</code>. This is an instruction that 1921the client should send the request body.</p> 1922<h5>Event: <code>'headers'</code><span><a class="mark" href="#event-headers" id="event-headers">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_headers"></a></h5> 1923<div class="api_metadata"> 1924<span>Added in: v8.4.0</span> 1925</div> 1926<ul> 1927<li><code>headers</code> <a href="http2.html#headers-object" class="type"><HTTP/2 Headers Object></a></li> 1928<li><code>flags</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 1929</ul> 1930<p>The <code>'headers'</code> event is emitted when an additional block of headers is received 1931for a stream, such as when a block of <code>1xx</code> informational headers is received. 1932The listener callback is passed the <a href="#headers-object">HTTP/2 Headers Object</a> and flags 1933associated with the headers.</p> 1934<pre><code class="language-js">stream.<span class="hljs-title function_">on</span>(<span class="hljs-string">'headers'</span>, <span class="hljs-function">(<span class="hljs-params">headers, flags</span>) =></span> { 1935 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(headers); 1936});</code> <button class="copy-button">copy</button></pre> 1937<h5>Event: <code>'push'</code><span><a class="mark" href="#event-push" id="event-push">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_push"></a></h5> 1938<div class="api_metadata"> 1939<span>Added in: v8.4.0</span> 1940</div> 1941<ul> 1942<li><code>headers</code> <a href="http2.html#headers-object" class="type"><HTTP/2 Headers Object></a></li> 1943<li><code>flags</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 1944</ul> 1945<p>The <code>'push'</code> event is emitted when response headers for a Server Push stream 1946are received. The listener callback is passed the <a href="#headers-object">HTTP/2 Headers Object</a> and 1947flags associated with the headers.</p> 1948<pre><code class="language-js">stream.<span class="hljs-title function_">on</span>(<span class="hljs-string">'push'</span>, <span class="hljs-function">(<span class="hljs-params">headers, flags</span>) =></span> { 1949 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(headers); 1950});</code> <button class="copy-button">copy</button></pre> 1951<h5>Event: <code>'response'</code><span><a class="mark" href="#event-response" id="event-response">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_response"></a></h5> 1952<div class="api_metadata"> 1953<span>Added in: v8.4.0</span> 1954</div> 1955<ul> 1956<li><code>headers</code> <a href="http2.html#headers-object" class="type"><HTTP/2 Headers Object></a></li> 1957<li><code>flags</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 1958</ul> 1959<p>The <code>'response'</code> event is emitted when a response <code>HEADERS</code> frame has been 1960received for this stream from the connected HTTP/2 server. The listener is 1961invoked with two arguments: an <code>Object</code> containing the received 1962<a href="#headers-object">HTTP/2 Headers Object</a>, and flags associated with the headers.</p> 1963<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 1964<span class="hljs-keyword">const</span> client = http2.<span class="hljs-title function_">connect</span>(<span class="hljs-string">'https://localhost'</span>); 1965<span class="hljs-keyword">const</span> req = client.<span class="hljs-title function_">request</span>({ <span class="hljs-string">':path'</span>: <span class="hljs-string">'/'</span> }); 1966req.<span class="hljs-title function_">on</span>(<span class="hljs-string">'response'</span>, <span class="hljs-function">(<span class="hljs-params">headers, flags</span>) =></span> { 1967 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(headers[<span class="hljs-string">':status'</span>]); 1968});</code> <button class="copy-button">copy</button></pre> 1969<h4>Class: <code>ServerHttp2Stream</code><span><a class="mark" href="#class-serverhttp2stream" id="class-serverhttp2stream">#</a></span><a aria-hidden="true" class="legacy" id="http2_class_serverhttp2stream"></a></h4> 1970<div class="api_metadata"> 1971<span>Added in: v8.4.0</span> 1972</div> 1973<ul> 1974<li>Extends: <a href="http2.html#class-http2stream" class="type"><Http2Stream></a></li> 1975</ul> 1976<p>The <code>ServerHttp2Stream</code> class is an extension of <a href="#class-http2stream"><code>Http2Stream</code></a> that is 1977used exclusively on HTTP/2 Servers. <code>Http2Stream</code> instances on the server 1978provide additional methods such as <code>http2stream.pushStream()</code> and 1979<code>http2stream.respond()</code> that are only relevant on the server.</p> 1980<h5><code>http2stream.additionalHeaders(headers)</code><span><a class="mark" href="#http2streamadditionalheadersheaders" id="http2streamadditionalheadersheaders">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2stream_additionalheaders_headers"></a></h5> 1981<div class="api_metadata"> 1982<span>Added in: v8.4.0</span> 1983</div> 1984<ul> 1985<li><code>headers</code> <a href="http2.html#headers-object" class="type"><HTTP/2 Headers Object></a></li> 1986</ul> 1987<p>Sends an additional informational <code>HEADERS</code> frame to the connected HTTP/2 peer.</p> 1988<h5><code>http2stream.headersSent</code><span><a class="mark" href="#http2streamheaderssent" id="http2streamheaderssent">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2stream_headerssent"></a></h5> 1989<div class="api_metadata"> 1990<span>Added in: v8.4.0</span> 1991</div> 1992<ul> 1993<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1994</ul> 1995<p>True if headers were sent, false otherwise (read-only).</p> 1996<h5><code>http2stream.pushAllowed</code><span><a class="mark" href="#http2streampushallowed" id="http2streampushallowed">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2stream_pushallowed"></a></h5> 1997<div class="api_metadata"> 1998<span>Added in: v8.4.0</span> 1999</div> 2000<ul> 2001<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 2002</ul> 2003<p>Read-only property mapped to the <code>SETTINGS_ENABLE_PUSH</code> flag of the remote 2004client's most recent <code>SETTINGS</code> frame. Will be <code>true</code> if the remote peer 2005accepts push streams, <code>false</code> otherwise. Settings are the same for every 2006<code>Http2Stream</code> in the same <code>Http2Session</code>.</p> 2007<h5><code>http2stream.pushStream(headers[, options], callback)</code><span><a class="mark" href="#http2streampushstreamheaders-options-callback" id="http2streampushstreamheaders-options-callback">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2stream_pushstream_headers_options_callback"></a></h5> 2008<div class="api_metadata"> 2009<details class="changelog"><summary>History</summary> 2010<table> 2011<tbody><tr><th>Version</th><th>Changes</th></tr> 2012<tr><td>v18.0.0</td> 2013<td><p>Passing an invalid callback to the <code>callback</code> argument now throws <code>ERR_INVALID_ARG_TYPE</code> instead of <code>ERR_INVALID_CALLBACK</code>.</p></td></tr> 2014<tr><td>v8.4.0</td> 2015<td><p><span>Added in: v8.4.0</span></p></td></tr> 2016</tbody></table> 2017</details> 2018</div> 2019<ul> 2020<li><code>headers</code> <a href="http2.html#headers-object" class="type"><HTTP/2 Headers Object></a></li> 2021<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 2022<ul> 2023<li><code>exclusive</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> When <code>true</code> and <code>parent</code> identifies a parent Stream, 2024the created stream is made the sole direct dependency of the parent, with 2025all other existing dependents made a dependent of the newly created stream. 2026<strong>Default:</strong> <code>false</code>.</li> 2027<li><code>parent</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Specifies the numeric identifier of a stream the newly 2028created stream is dependent on.</li> 2029</ul> 2030</li> 2031<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> Callback that is called once the push stream has been 2032initiated. 2033<ul> 2034<li><code>err</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" class="type"><Error></a></li> 2035<li><code>pushStream</code> <a href="http2.html#class-serverhttp2stream" class="type"><ServerHttp2Stream></a> The returned <code>pushStream</code> object.</li> 2036<li><code>headers</code> <a href="http2.html#headers-object" class="type"><HTTP/2 Headers Object></a> Headers object the <code>pushStream</code> was 2037initiated with.</li> 2038</ul> 2039</li> 2040</ul> 2041<p>Initiates a push stream. The callback is invoked with the new <code>Http2Stream</code> 2042instance created for the push stream passed as the second argument, or an 2043<code>Error</code> passed as the first argument.</p> 2044<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 2045<span class="hljs-keyword">const</span> server = http2.<span class="hljs-title function_">createServer</span>(); 2046server.<span class="hljs-title function_">on</span>(<span class="hljs-string">'stream'</span>, <span class="hljs-function">(<span class="hljs-params">stream</span>) =></span> { 2047 stream.<span class="hljs-title function_">respond</span>({ <span class="hljs-string">':status'</span>: <span class="hljs-number">200</span> }); 2048 stream.<span class="hljs-title function_">pushStream</span>({ <span class="hljs-string">':path'</span>: <span class="hljs-string">'/'</span> }, <span class="hljs-function">(<span class="hljs-params">err, pushStream, headers</span>) =></span> { 2049 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 2050 pushStream.<span class="hljs-title function_">respond</span>({ <span class="hljs-string">':status'</span>: <span class="hljs-number">200</span> }); 2051 pushStream.<span class="hljs-title function_">end</span>(<span class="hljs-string">'some pushed data'</span>); 2052 }); 2053 stream.<span class="hljs-title function_">end</span>(<span class="hljs-string">'some data'</span>); 2054});</code> <button class="copy-button">copy</button></pre> 2055<p>Setting the weight of a push stream is not allowed in the <code>HEADERS</code> frame. Pass 2056a <code>weight</code> value to <code>http2stream.priority</code> with the <code>silent</code> option set to 2057<code>true</code> to enable server-side bandwidth balancing between concurrent streams.</p> 2058<p>Calling <code>http2stream.pushStream()</code> from within a pushed stream is not permitted 2059and will throw an error.</p> 2060<h5><code>http2stream.respond([headers[, options]])</code><span><a class="mark" href="#http2streamrespondheaders-options" id="http2streamrespondheaders-options">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2stream_respond_headers_options"></a></h5> 2061<div class="api_metadata"> 2062<details class="changelog"><summary>History</summary> 2063<table> 2064<tbody><tr><th>Version</th><th>Changes</th></tr> 2065<tr><td>v14.5.0, v12.19.0</td> 2066<td><p>Allow explicitly setting date headers.</p></td></tr> 2067<tr><td>v8.4.0</td> 2068<td><p><span>Added in: v8.4.0</span></p></td></tr> 2069</tbody></table> 2070</details> 2071</div> 2072<ul> 2073<li><code>headers</code> <a href="http2.html#headers-object" class="type"><HTTP/2 Headers Object></a></li> 2074<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 2075<ul> 2076<li><code>endStream</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> Set to <code>true</code> to indicate that the response will not 2077include payload data.</li> 2078<li><code>waitForTrailers</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> When <code>true</code>, the <code>Http2Stream</code> will emit the 2079<code>'wantTrailers'</code> event after the final <code>DATA</code> frame has been sent.</li> 2080</ul> 2081</li> 2082</ul> 2083<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 2084<span class="hljs-keyword">const</span> server = http2.<span class="hljs-title function_">createServer</span>(); 2085server.<span class="hljs-title function_">on</span>(<span class="hljs-string">'stream'</span>, <span class="hljs-function">(<span class="hljs-params">stream</span>) =></span> { 2086 stream.<span class="hljs-title function_">respond</span>({ <span class="hljs-string">':status'</span>: <span class="hljs-number">200</span> }); 2087 stream.<span class="hljs-title function_">end</span>(<span class="hljs-string">'some data'</span>); 2088});</code> <button class="copy-button">copy</button></pre> 2089<p>Initiates a response. When the <code>options.waitForTrailers</code> option is set, the 2090<code>'wantTrailers'</code> event will be emitted immediately after queuing the last chunk 2091of payload data to be sent. The <code>http2stream.sendTrailers()</code> method can then be 2092used to sent trailing header fields to the peer.</p> 2093<p>When <code>options.waitForTrailers</code> is set, the <code>Http2Stream</code> will not automatically 2094close when the final <code>DATA</code> frame is transmitted. User code must call either 2095<code>http2stream.sendTrailers()</code> or <code>http2stream.close()</code> to close the 2096<code>Http2Stream</code>.</p> 2097<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 2098<span class="hljs-keyword">const</span> server = http2.<span class="hljs-title function_">createServer</span>(); 2099server.<span class="hljs-title function_">on</span>(<span class="hljs-string">'stream'</span>, <span class="hljs-function">(<span class="hljs-params">stream</span>) =></span> { 2100 stream.<span class="hljs-title function_">respond</span>({ <span class="hljs-string">':status'</span>: <span class="hljs-number">200</span> }, { <span class="hljs-attr">waitForTrailers</span>: <span class="hljs-literal">true</span> }); 2101 stream.<span class="hljs-title function_">on</span>(<span class="hljs-string">'wantTrailers'</span>, <span class="hljs-function">() =></span> { 2102 stream.<span class="hljs-title function_">sendTrailers</span>({ <span class="hljs-attr">ABC</span>: <span class="hljs-string">'some value to send'</span> }); 2103 }); 2104 stream.<span class="hljs-title function_">end</span>(<span class="hljs-string">'some data'</span>); 2105});</code> <button class="copy-button">copy</button></pre> 2106<h5><code>http2stream.respondWithFD(fd[, headers[, options]])</code><span><a class="mark" href="#http2streamrespondwithfdfd-headers-options" id="http2streamrespondwithfdfd-headers-options">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2stream_respondwithfd_fd_headers_options"></a></h5> 2107<div class="api_metadata"> 2108<details class="changelog"><summary>History</summary> 2109<table> 2110<tbody><tr><th>Version</th><th>Changes</th></tr> 2111<tr><td>v14.5.0, v12.19.0</td> 2112<td><p>Allow explicitly setting date headers.</p></td></tr> 2113<tr><td>v12.12.0</td> 2114<td><p>The <code>fd</code> option may now be a <code>FileHandle</code>.</p></td></tr> 2115<tr><td>v10.0.0</td> 2116<td><p>Any readable file descriptor, not necessarily for a regular file, is supported now.</p></td></tr> 2117<tr><td>v8.4.0</td> 2118<td><p><span>Added in: v8.4.0</span></p></td></tr> 2119</tbody></table> 2120</details> 2121</div> 2122<ul> 2123<li><code>fd</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> | <a href="fs.html#class-filehandle" class="type"><FileHandle></a> A readable file descriptor.</li> 2124<li><code>headers</code> <a href="http2.html#headers-object" class="type"><HTTP/2 Headers Object></a></li> 2125<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 2126<ul> 2127<li><code>statCheck</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 2128<li><code>waitForTrailers</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> When <code>true</code>, the <code>Http2Stream</code> will emit the 2129<code>'wantTrailers'</code> event after the final <code>DATA</code> frame has been sent.</li> 2130<li><code>offset</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The offset position at which to begin reading.</li> 2131<li><code>length</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The amount of data from the fd to send.</li> 2132</ul> 2133</li> 2134</ul> 2135<p>Initiates a response whose data is read from the given file descriptor. No 2136validation is performed on the given file descriptor. If an error occurs while 2137attempting to read data using the file descriptor, the <code>Http2Stream</code> will be 2138closed using an <code>RST_STREAM</code> frame using the standard <code>INTERNAL_ERROR</code> code.</p> 2139<p>When used, the <code>Http2Stream</code> object's <code>Duplex</code> interface will be closed 2140automatically.</p> 2141<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 2142<span class="hljs-keyword">const</span> fs = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:fs'</span>); 2143 2144<span class="hljs-keyword">const</span> server = http2.<span class="hljs-title function_">createServer</span>(); 2145server.<span class="hljs-title function_">on</span>(<span class="hljs-string">'stream'</span>, <span class="hljs-function">(<span class="hljs-params">stream</span>) =></span> { 2146 <span class="hljs-keyword">const</span> fd = fs.<span class="hljs-title function_">openSync</span>(<span class="hljs-string">'/some/file'</span>, <span class="hljs-string">'r'</span>); 2147 2148 <span class="hljs-keyword">const</span> stat = fs.<span class="hljs-title function_">fstatSync</span>(fd); 2149 <span class="hljs-keyword">const</span> headers = { 2150 <span class="hljs-string">'content-length'</span>: stat.<span class="hljs-property">size</span>, 2151 <span class="hljs-string">'last-modified'</span>: stat.<span class="hljs-property">mtime</span>.<span class="hljs-title function_">toUTCString</span>(), 2152 <span class="hljs-string">'content-type'</span>: <span class="hljs-string">'text/plain; charset=utf-8'</span>, 2153 }; 2154 stream.<span class="hljs-title function_">respondWithFD</span>(fd, headers); 2155 stream.<span class="hljs-title function_">on</span>(<span class="hljs-string">'close'</span>, <span class="hljs-function">() =></span> fs.<span class="hljs-title function_">closeSync</span>(fd)); 2156});</code> <button class="copy-button">copy</button></pre> 2157<p>The optional <code>options.statCheck</code> function may be specified to give user code 2158an opportunity to set additional content headers based on the <code>fs.Stat</code> details 2159of the given fd. If the <code>statCheck</code> function is provided, the 2160<code>http2stream.respondWithFD()</code> method will perform an <code>fs.fstat()</code> call to 2161collect details on the provided file descriptor.</p> 2162<p>The <code>offset</code> and <code>length</code> options may be used to limit the response to a 2163specific range subset. This can be used, for instance, to support HTTP Range 2164requests.</p> 2165<p>The file descriptor or <code>FileHandle</code> is not closed when the stream is closed, 2166so it will need to be closed manually once it is no longer needed. 2167Using the same file descriptor concurrently for multiple streams 2168is not supported and may result in data loss. Re-using a file descriptor 2169after a stream has finished is supported.</p> 2170<p>When the <code>options.waitForTrailers</code> option is set, the <code>'wantTrailers'</code> event 2171will be emitted immediately after queuing the last chunk of payload data to be 2172sent. The <code>http2stream.sendTrailers()</code> method can then be used to sent trailing 2173header fields to the peer.</p> 2174<p>When <code>options.waitForTrailers</code> is set, the <code>Http2Stream</code> will not automatically 2175close when the final <code>DATA</code> frame is transmitted. User code <em>must</em> call either 2176<code>http2stream.sendTrailers()</code> or <code>http2stream.close()</code> to close the 2177<code>Http2Stream</code>.</p> 2178<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 2179<span class="hljs-keyword">const</span> fs = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:fs'</span>); 2180 2181<span class="hljs-keyword">const</span> server = http2.<span class="hljs-title function_">createServer</span>(); 2182server.<span class="hljs-title function_">on</span>(<span class="hljs-string">'stream'</span>, <span class="hljs-function">(<span class="hljs-params">stream</span>) =></span> { 2183 <span class="hljs-keyword">const</span> fd = fs.<span class="hljs-title function_">openSync</span>(<span class="hljs-string">'/some/file'</span>, <span class="hljs-string">'r'</span>); 2184 2185 <span class="hljs-keyword">const</span> stat = fs.<span class="hljs-title function_">fstatSync</span>(fd); 2186 <span class="hljs-keyword">const</span> headers = { 2187 <span class="hljs-string">'content-length'</span>: stat.<span class="hljs-property">size</span>, 2188 <span class="hljs-string">'last-modified'</span>: stat.<span class="hljs-property">mtime</span>.<span class="hljs-title function_">toUTCString</span>(), 2189 <span class="hljs-string">'content-type'</span>: <span class="hljs-string">'text/plain; charset=utf-8'</span>, 2190 }; 2191 stream.<span class="hljs-title function_">respondWithFD</span>(fd, headers, { <span class="hljs-attr">waitForTrailers</span>: <span class="hljs-literal">true</span> }); 2192 stream.<span class="hljs-title function_">on</span>(<span class="hljs-string">'wantTrailers'</span>, <span class="hljs-function">() =></span> { 2193 stream.<span class="hljs-title function_">sendTrailers</span>({ <span class="hljs-attr">ABC</span>: <span class="hljs-string">'some value to send'</span> }); 2194 }); 2195 2196 stream.<span class="hljs-title function_">on</span>(<span class="hljs-string">'close'</span>, <span class="hljs-function">() =></span> fs.<span class="hljs-title function_">closeSync</span>(fd)); 2197});</code> <button class="copy-button">copy</button></pre> 2198<h5><code>http2stream.respondWithFile(path[, headers[, options]])</code><span><a class="mark" href="#http2streamrespondwithfilepath-headers-options" id="http2streamrespondwithfilepath-headers-options">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2stream_respondwithfile_path_headers_options"></a></h5> 2199<div class="api_metadata"> 2200<details class="changelog"><summary>History</summary> 2201<table> 2202<tbody><tr><th>Version</th><th>Changes</th></tr> 2203<tr><td>v14.5.0, v12.19.0</td> 2204<td><p>Allow explicitly setting date headers.</p></td></tr> 2205<tr><td>v10.0.0</td> 2206<td><p>Any readable file, not necessarily a regular file, is supported now.</p></td></tr> 2207<tr><td>v8.4.0</td> 2208<td><p><span>Added in: v8.4.0</span></p></td></tr> 2209</tbody></table> 2210</details> 2211</div> 2212<ul> 2213<li><code>path</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> | <a href="buffer.html#class-buffer" class="type"><Buffer></a> | <a href="url.html#the-whatwg-url-api" class="type"><URL></a></li> 2214<li><code>headers</code> <a href="http2.html#headers-object" class="type"><HTTP/2 Headers Object></a></li> 2215<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 2216<ul> 2217<li><code>statCheck</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 2218<li><code>onError</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> Callback function invoked in the case of an 2219error before send.</li> 2220<li><code>waitForTrailers</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> When <code>true</code>, the <code>Http2Stream</code> will emit the 2221<code>'wantTrailers'</code> event after the final <code>DATA</code> frame has been sent.</li> 2222<li><code>offset</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The offset position at which to begin reading.</li> 2223<li><code>length</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The amount of data from the fd to send.</li> 2224</ul> 2225</li> 2226</ul> 2227<p>Sends a regular file as the response. The <code>path</code> must specify a regular file 2228or an <code>'error'</code> event will be emitted on the <code>Http2Stream</code> object.</p> 2229<p>When used, the <code>Http2Stream</code> object's <code>Duplex</code> interface will be closed 2230automatically.</p> 2231<p>The optional <code>options.statCheck</code> function may be specified to give user code 2232an opportunity to set additional content headers based on the <code>fs.Stat</code> details 2233of the given file:</p> 2234<p>If an error occurs while attempting to read the file data, the <code>Http2Stream</code> 2235will be closed using an <code>RST_STREAM</code> frame using the standard <code>INTERNAL_ERROR</code> 2236code. If the <code>onError</code> callback is defined, then it will be called. Otherwise 2237the stream will be destroyed.</p> 2238<p>Example using a file path:</p> 2239<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 2240<span class="hljs-keyword">const</span> server = http2.<span class="hljs-title function_">createServer</span>(); 2241server.<span class="hljs-title function_">on</span>(<span class="hljs-string">'stream'</span>, <span class="hljs-function">(<span class="hljs-params">stream</span>) =></span> { 2242 <span class="hljs-keyword">function</span> <span class="hljs-title function_">statCheck</span>(<span class="hljs-params">stat, headers</span>) { 2243 headers[<span class="hljs-string">'last-modified'</span>] = stat.<span class="hljs-property">mtime</span>.<span class="hljs-title function_">toUTCString</span>(); 2244 } 2245 2246 <span class="hljs-keyword">function</span> <span class="hljs-title function_">onError</span>(<span class="hljs-params">err</span>) { 2247 <span class="hljs-comment">// stream.respond() can throw if the stream has been destroyed by</span> 2248 <span class="hljs-comment">// the other side.</span> 2249 <span class="hljs-keyword">try</span> { 2250 <span class="hljs-keyword">if</span> (err.<span class="hljs-property">code</span> === <span class="hljs-string">'ENOENT'</span>) { 2251 stream.<span class="hljs-title function_">respond</span>({ <span class="hljs-string">':status'</span>: <span class="hljs-number">404</span> }); 2252 } <span class="hljs-keyword">else</span> { 2253 stream.<span class="hljs-title function_">respond</span>({ <span class="hljs-string">':status'</span>: <span class="hljs-number">500</span> }); 2254 } 2255 } <span class="hljs-keyword">catch</span> (err) { 2256 <span class="hljs-comment">// Perform actual error handling.</span> 2257 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">error</span>(err); 2258 } 2259 stream.<span class="hljs-title function_">end</span>(); 2260 } 2261 2262 stream.<span class="hljs-title function_">respondWithFile</span>(<span class="hljs-string">'/some/file'</span>, 2263 { <span class="hljs-string">'content-type'</span>: <span class="hljs-string">'text/plain; charset=utf-8'</span> }, 2264 { statCheck, onError }); 2265});</code> <button class="copy-button">copy</button></pre> 2266<p>The <code>options.statCheck</code> function may also be used to cancel the send operation 2267by returning <code>false</code>. For instance, a conditional request may check the stat 2268results to determine if the file has been modified to return an appropriate 2269<code>304</code> response:</p> 2270<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 2271<span class="hljs-keyword">const</span> server = http2.<span class="hljs-title function_">createServer</span>(); 2272server.<span class="hljs-title function_">on</span>(<span class="hljs-string">'stream'</span>, <span class="hljs-function">(<span class="hljs-params">stream</span>) =></span> { 2273 <span class="hljs-keyword">function</span> <span class="hljs-title function_">statCheck</span>(<span class="hljs-params">stat, headers</span>) { 2274 <span class="hljs-comment">// Check the stat here...</span> 2275 stream.<span class="hljs-title function_">respond</span>({ <span class="hljs-string">':status'</span>: <span class="hljs-number">304</span> }); 2276 <span class="hljs-keyword">return</span> <span class="hljs-literal">false</span>; <span class="hljs-comment">// Cancel the send operation</span> 2277 } 2278 stream.<span class="hljs-title function_">respondWithFile</span>(<span class="hljs-string">'/some/file'</span>, 2279 { <span class="hljs-string">'content-type'</span>: <span class="hljs-string">'text/plain; charset=utf-8'</span> }, 2280 { statCheck }); 2281});</code> <button class="copy-button">copy</button></pre> 2282<p>The <code>content-length</code> header field will be automatically set.</p> 2283<p>The <code>offset</code> and <code>length</code> options may be used to limit the response to a 2284specific range subset. This can be used, for instance, to support HTTP Range 2285requests.</p> 2286<p>The <code>options.onError</code> function may also be used to handle all the errors 2287that could happen before the delivery of the file is initiated. The 2288default behavior is to destroy the stream.</p> 2289<p>When the <code>options.waitForTrailers</code> option is set, the <code>'wantTrailers'</code> event 2290will be emitted immediately after queuing the last chunk of payload data to be 2291sent. The <code>http2stream.sendTrailers()</code> method can then be used to sent trailing 2292header fields to the peer.</p> 2293<p>When <code>options.waitForTrailers</code> is set, the <code>Http2Stream</code> will not automatically 2294close when the final <code>DATA</code> frame is transmitted. User code must call either 2295<code>http2stream.sendTrailers()</code> or <code>http2stream.close()</code> to close the 2296<code>Http2Stream</code>.</p> 2297<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 2298<span class="hljs-keyword">const</span> server = http2.<span class="hljs-title function_">createServer</span>(); 2299server.<span class="hljs-title function_">on</span>(<span class="hljs-string">'stream'</span>, <span class="hljs-function">(<span class="hljs-params">stream</span>) =></span> { 2300 stream.<span class="hljs-title function_">respondWithFile</span>(<span class="hljs-string">'/some/file'</span>, 2301 { <span class="hljs-string">'content-type'</span>: <span class="hljs-string">'text/plain; charset=utf-8'</span> }, 2302 { <span class="hljs-attr">waitForTrailers</span>: <span class="hljs-literal">true</span> }); 2303 stream.<span class="hljs-title function_">on</span>(<span class="hljs-string">'wantTrailers'</span>, <span class="hljs-function">() =></span> { 2304 stream.<span class="hljs-title function_">sendTrailers</span>({ <span class="hljs-attr">ABC</span>: <span class="hljs-string">'some value to send'</span> }); 2305 }); 2306});</code> <button class="copy-button">copy</button></pre> 2307<h4>Class: <code>Http2Server</code><span><a class="mark" href="#class-http2server" id="class-http2server">#</a></span><a aria-hidden="true" class="legacy" id="http2_class_http2server"></a></h4> 2308<div class="api_metadata"> 2309<span>Added in: v8.4.0</span> 2310</div> 2311<ul> 2312<li>Extends: <a href="net.html#class-netserver" class="type"><net.Server></a></li> 2313</ul> 2314<p>Instances of <code>Http2Server</code> are created using the <code>http2.createServer()</code> 2315function. The <code>Http2Server</code> class is not exported directly by the 2316<code>node:http2</code> module.</p> 2317<h5>Event: <code>'checkContinue'</code><span><a class="mark" href="#event-checkcontinue" id="event-checkcontinue">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_checkcontinue"></a></h5> 2318<div class="api_metadata"> 2319<span>Added in: v8.5.0</span> 2320</div> 2321<ul> 2322<li><code>request</code> <a href="http2.html#class-http2http2serverrequest" class="type"><http2.Http2ServerRequest></a></li> 2323<li><code>response</code> <a href="http2.html#class-http2http2serverresponse" class="type"><http2.Http2ServerResponse></a></li> 2324</ul> 2325<p>If a <a href="#event-request"><code>'request'</code></a> listener is registered or <a href="#http2createserveroptions-onrequesthandler"><code>http2.createServer()</code></a> is 2326supplied a callback function, the <code>'checkContinue'</code> event is emitted each time 2327a request with an HTTP <code>Expect: 100-continue</code> is received. If this event is 2328not listened for, the server will automatically respond with a status 2329<code>100 Continue</code> as appropriate.</p> 2330<p>Handling this event involves calling <a href="#responsewritecontinue"><code>response.writeContinue()</code></a> if the 2331client should continue to send the request body, or generating an appropriate 2332HTTP response (e.g. 400 Bad Request) if the client should not continue to send 2333the request body.</p> 2334<p>When this event is emitted and handled, the <a href="#event-request"><code>'request'</code></a> event will 2335not be emitted.</p> 2336<h5>Event: <code>'connection'</code><span><a class="mark" href="#event-connection" id="event-connection">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_connection"></a></h5> 2337<div class="api_metadata"> 2338<span>Added in: v8.4.0</span> 2339</div> 2340<ul> 2341<li><code>socket</code> <a href="stream.html#class-streamduplex" class="type"><stream.Duplex></a></li> 2342</ul> 2343<p>This event is emitted when a new TCP stream is established. <code>socket</code> is 2344typically an object of type <a href="net.html#class-netsocket"><code>net.Socket</code></a>. Usually users will not want to 2345access this event.</p> 2346<p>This event can also be explicitly emitted by users to inject connections 2347into the HTTP server. In that case, any <a href="stream.html#class-streamduplex"><code>Duplex</code></a> stream can be passed.</p> 2348<h5>Event: <code>'request'</code><span><a class="mark" href="#event-request" id="event-request">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_request"></a></h5> 2349<div class="api_metadata"> 2350<span>Added in: v8.4.0</span> 2351</div> 2352<ul> 2353<li><code>request</code> <a href="http2.html#class-http2http2serverrequest" class="type"><http2.Http2ServerRequest></a></li> 2354<li><code>response</code> <a href="http2.html#class-http2http2serverresponse" class="type"><http2.Http2ServerResponse></a></li> 2355</ul> 2356<p>Emitted each time there is a request. There may be multiple requests 2357per session. See the <a href="#compatibility-api">Compatibility API</a>.</p> 2358<h5>Event: <code>'session'</code><span><a class="mark" href="#event-session" id="event-session">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_session"></a></h5> 2359<div class="api_metadata"> 2360<span>Added in: v8.4.0</span> 2361</div> 2362<ul> 2363<li><code>session</code> <a href="http2.html#class-serverhttp2session" class="type"><ServerHttp2Session></a></li> 2364</ul> 2365<p>The <code>'session'</code> event is emitted when a new <code>Http2Session</code> is created by the 2366<code>Http2Server</code>.</p> 2367<h5>Event: <code>'sessionError'</code><span><a class="mark" href="#event-sessionerror" id="event-sessionerror">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_sessionerror"></a></h5> 2368<div class="api_metadata"> 2369<span>Added in: v8.4.0</span> 2370</div> 2371<ul> 2372<li><code>error</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" class="type"><Error></a></li> 2373<li><code>session</code> <a href="http2.html#class-serverhttp2session" class="type"><ServerHttp2Session></a></li> 2374</ul> 2375<p>The <code>'sessionError'</code> event is emitted when an <code>'error'</code> event is emitted by 2376an <code>Http2Session</code> object associated with the <code>Http2Server</code>.</p> 2377<h5>Event: <code>'stream'</code><span><a class="mark" href="#event-stream_1" id="event-stream_1">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_stream_1"></a></h5> 2378<div class="api_metadata"> 2379<span>Added in: v8.4.0</span> 2380</div> 2381<ul> 2382<li><code>stream</code> <a href="http2.html#class-http2stream" class="type"><Http2Stream></a> A reference to the stream</li> 2383<li><code>headers</code> <a href="http2.html#headers-object" class="type"><HTTP/2 Headers Object></a> An object describing the headers</li> 2384<li><code>flags</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The associated numeric flags</li> 2385<li><code>rawHeaders</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="type"><Array></a> An array containing the raw header names followed by 2386their respective values.</li> 2387</ul> 2388<p>The <code>'stream'</code> event is emitted when a <code>'stream'</code> event has been emitted by 2389an <code>Http2Session</code> associated with the server.</p> 2390<p>See also <a href="#event-stream"><code>Http2Session</code>'s <code>'stream'</code> event</a>.</p> 2391<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 2392<span class="hljs-keyword">const</span> { 2393 <span class="hljs-title class_">HTTP2</span>_HEADER_METHOD, 2394 <span class="hljs-title class_">HTTP2</span>_HEADER_PATH, 2395 <span class="hljs-title class_">HTTP2</span>_HEADER_STATUS, 2396 <span class="hljs-title class_">HTTP2</span>_HEADER_CONTENT_TYPE, 2397} = http2.<span class="hljs-property">constants</span>; 2398 2399<span class="hljs-keyword">const</span> server = http2.<span class="hljs-title function_">createServer</span>(); 2400server.<span class="hljs-title function_">on</span>(<span class="hljs-string">'stream'</span>, <span class="hljs-function">(<span class="hljs-params">stream, headers, flags</span>) =></span> { 2401 <span class="hljs-keyword">const</span> method = headers[<span class="hljs-title class_">HTTP2</span>_HEADER_METHOD]; 2402 <span class="hljs-keyword">const</span> path = headers[<span class="hljs-title class_">HTTP2</span>_HEADER_PATH]; 2403 <span class="hljs-comment">// ...</span> 2404 stream.<span class="hljs-title function_">respond</span>({ 2405 [<span class="hljs-title class_">HTTP2</span>_HEADER_STATUS]: <span class="hljs-number">200</span>, 2406 [<span class="hljs-title class_">HTTP2</span>_HEADER_CONTENT_TYPE]: <span class="hljs-string">'text/plain; charset=utf-8'</span>, 2407 }); 2408 stream.<span class="hljs-title function_">write</span>(<span class="hljs-string">'hello '</span>); 2409 stream.<span class="hljs-title function_">end</span>(<span class="hljs-string">'world'</span>); 2410});</code> <button class="copy-button">copy</button></pre> 2411<h5>Event: <code>'timeout'</code><span><a class="mark" href="#event-timeout_2" id="event-timeout_2">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_timeout_2"></a></h5> 2412<div class="api_metadata"> 2413<details class="changelog"><summary>History</summary> 2414<table> 2415<tbody><tr><th>Version</th><th>Changes</th></tr> 2416<tr><td>v13.0.0</td> 2417<td><p>The default timeout changed from 120s to 0 (no timeout).</p></td></tr> 2418<tr><td>v8.4.0</td> 2419<td><p><span>Added in: v8.4.0</span></p></td></tr> 2420</tbody></table> 2421</details> 2422</div> 2423<p>The <code>'timeout'</code> event is emitted when there is no activity on the Server for 2424a given number of milliseconds set using <code>http2server.setTimeout()</code>. 2425<strong>Default:</strong> 0 (no timeout)</p> 2426<h5><code>server.close([callback])</code><span><a class="mark" href="#serverclosecallback" id="serverclosecallback">#</a></span><a aria-hidden="true" class="legacy" id="http2_server_close_callback"></a></h5> 2427<div class="api_metadata"> 2428<span>Added in: v8.4.0</span> 2429</div> 2430<ul> 2431<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 2432</ul> 2433<p>Stops the server from establishing new sessions. This does not prevent new 2434request streams from being created due to the persistent nature of HTTP/2 2435sessions. To gracefully shut down the server, call <a href="#http2sessionclosecallback"><code>http2session.close()</code></a> on 2436all active sessions.</p> 2437<p>If <code>callback</code> is provided, it is not invoked until all active sessions have been 2438closed, although the server has already stopped allowing new sessions. See 2439<a href="net.html#serverclosecallback"><code>net.Server.close()</code></a> for more details.</p> 2440<h5><code>server.setTimeout([msecs][, callback])</code><span><a class="mark" href="#serversettimeoutmsecs-callback" id="serversettimeoutmsecs-callback">#</a></span><a aria-hidden="true" class="legacy" id="http2_server_settimeout_msecs_callback"></a></h5> 2441<div class="api_metadata"> 2442<details class="changelog"><summary>History</summary> 2443<table> 2444<tbody><tr><th>Version</th><th>Changes</th></tr> 2445<tr><td>v18.0.0</td> 2446<td><p>Passing an invalid callback to the <code>callback</code> argument now throws <code>ERR_INVALID_ARG_TYPE</code> instead of <code>ERR_INVALID_CALLBACK</code>.</p></td></tr> 2447<tr><td>v13.0.0</td> 2448<td><p>The default timeout changed from 120s to 0 (no timeout).</p></td></tr> 2449<tr><td>v8.4.0</td> 2450<td><p><span>Added in: v8.4.0</span></p></td></tr> 2451</tbody></table> 2452</details> 2453</div> 2454<ul> 2455<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> 2456<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 2457<li>Returns: <a href="http2.html#class-http2server" class="type"><Http2Server></a></li> 2458</ul> 2459<p>Used to set the timeout value for http2 server requests, 2460and sets a callback function that is called when there is no activity 2461on the <code>Http2Server</code> after <code>msecs</code> milliseconds.</p> 2462<p>The given callback is registered as a listener on the <code>'timeout'</code> event.</p> 2463<p>In case if <code>callback</code> is not a function, a new <code>ERR_INVALID_ARG_TYPE</code> 2464error will be thrown.</p> 2465<h5><code>server.timeout</code><span><a class="mark" href="#servertimeout" id="servertimeout">#</a></span><a aria-hidden="true" class="legacy" id="http2_server_timeout"></a></h5> 2466<div class="api_metadata"> 2467<details class="changelog"><summary>History</summary> 2468<table> 2469<tbody><tr><th>Version</th><th>Changes</th></tr> 2470<tr><td>v13.0.0</td> 2471<td><p>The default timeout changed from 120s to 0 (no timeout).</p></td></tr> 2472<tr><td>v8.4.0</td> 2473<td><p><span>Added in: v8.4.0</span></p></td></tr> 2474</tbody></table> 2475</details> 2476</div> 2477<ul> 2478<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> 2479</ul> 2480<p>The number of milliseconds of inactivity before a socket is presumed 2481to have timed out.</p> 2482<p>A value of <code>0</code> will disable the timeout behavior on incoming connections.</p> 2483<p>The socket timeout logic is set up on connection, so changing this 2484value only affects new connections to the server, not any existing connections.</p> 2485<h5><code>server.updateSettings([settings])</code><span><a class="mark" href="#serverupdatesettingssettings" id="serverupdatesettingssettings">#</a></span><a aria-hidden="true" class="legacy" id="http2_server_updatesettings_settings"></a></h5> 2486<div class="api_metadata"> 2487<span>Added in: v15.1.0, v14.17.0</span> 2488</div> 2489<ul> 2490<li><code>settings</code> <a href="http2.html#settings-object" class="type"><HTTP/2 Settings Object></a></li> 2491</ul> 2492<p>Used to update the server with the provided settings.</p> 2493<p>Throws <code>ERR_HTTP2_INVALID_SETTING_VALUE</code> for invalid <code>settings</code> values.</p> 2494<p>Throws <code>ERR_INVALID_ARG_TYPE</code> for invalid <code>settings</code> argument.</p> 2495<h4>Class: <code>Http2SecureServer</code><span><a class="mark" href="#class-http2secureserver" id="class-http2secureserver">#</a></span><a aria-hidden="true" class="legacy" id="http2_class_http2secureserver"></a></h4> 2496<div class="api_metadata"> 2497<span>Added in: v8.4.0</span> 2498</div> 2499<ul> 2500<li>Extends: <a href="tls.html#class-tlsserver" class="type"><tls.Server></a></li> 2501</ul> 2502<p>Instances of <code>Http2SecureServer</code> are created using the 2503<code>http2.createSecureServer()</code> function. The <code>Http2SecureServer</code> class is not 2504exported directly by the <code>node:http2</code> module.</p> 2505<h5>Event: <code>'checkContinue'</code><span><a class="mark" href="#event-checkcontinue_1" id="event-checkcontinue_1">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_checkcontinue_1"></a></h5> 2506<div class="api_metadata"> 2507<span>Added in: v8.5.0</span> 2508</div> 2509<ul> 2510<li><code>request</code> <a href="http2.html#class-http2http2serverrequest" class="type"><http2.Http2ServerRequest></a></li> 2511<li><code>response</code> <a href="http2.html#class-http2http2serverresponse" class="type"><http2.Http2ServerResponse></a></li> 2512</ul> 2513<p>If a <a href="#event-request"><code>'request'</code></a> listener is registered or <a href="#http2createsecureserveroptions-onrequesthandler"><code>http2.createSecureServer()</code></a> 2514is supplied a callback function, the <code>'checkContinue'</code> event is emitted each 2515time a request with an HTTP <code>Expect: 100-continue</code> is received. If this event 2516is not listened for, the server will automatically respond with a status 2517<code>100 Continue</code> as appropriate.</p> 2518<p>Handling this event involves calling <a href="#responsewritecontinue"><code>response.writeContinue()</code></a> if the 2519client should continue to send the request body, or generating an appropriate 2520HTTP response (e.g. 400 Bad Request) if the client should not continue to send 2521the request body.</p> 2522<p>When this event is emitted and handled, the <a href="#event-request"><code>'request'</code></a> event will 2523not be emitted.</p> 2524<h5>Event: <code>'connection'</code><span><a class="mark" href="#event-connection_1" id="event-connection_1">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_connection_1"></a></h5> 2525<div class="api_metadata"> 2526<span>Added in: v8.4.0</span> 2527</div> 2528<ul> 2529<li><code>socket</code> <a href="stream.html#class-streamduplex" class="type"><stream.Duplex></a></li> 2530</ul> 2531<p>This event is emitted when a new TCP stream is established, before the TLS 2532handshake begins. <code>socket</code> is typically an object of type <a href="net.html#class-netsocket"><code>net.Socket</code></a>. 2533Usually users will not want to access this event.</p> 2534<p>This event can also be explicitly emitted by users to inject connections 2535into the HTTP server. In that case, any <a href="stream.html#class-streamduplex"><code>Duplex</code></a> stream can be passed.</p> 2536<h5>Event: <code>'request'</code><span><a class="mark" href="#event-request_1" id="event-request_1">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_request_1"></a></h5> 2537<div class="api_metadata"> 2538<span>Added in: v8.4.0</span> 2539</div> 2540<ul> 2541<li><code>request</code> <a href="http2.html#class-http2http2serverrequest" class="type"><http2.Http2ServerRequest></a></li> 2542<li><code>response</code> <a href="http2.html#class-http2http2serverresponse" class="type"><http2.Http2ServerResponse></a></li> 2543</ul> 2544<p>Emitted each time there is a request. There may be multiple requests 2545per session. See the <a href="#compatibility-api">Compatibility API</a>.</p> 2546<h5>Event: <code>'session'</code><span><a class="mark" href="#event-session_1" id="event-session_1">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_session_1"></a></h5> 2547<div class="api_metadata"> 2548<span>Added in: v8.4.0</span> 2549</div> 2550<ul> 2551<li><code>session</code> <a href="http2.html#class-serverhttp2session" class="type"><ServerHttp2Session></a></li> 2552</ul> 2553<p>The <code>'session'</code> event is emitted when a new <code>Http2Session</code> is created by the 2554<code>Http2SecureServer</code>.</p> 2555<h5>Event: <code>'sessionError'</code><span><a class="mark" href="#event-sessionerror_1" id="event-sessionerror_1">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_sessionerror_1"></a></h5> 2556<div class="api_metadata"> 2557<span>Added in: v8.4.0</span> 2558</div> 2559<ul> 2560<li><code>error</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" class="type"><Error></a></li> 2561<li><code>session</code> <a href="http2.html#class-serverhttp2session" class="type"><ServerHttp2Session></a></li> 2562</ul> 2563<p>The <code>'sessionError'</code> event is emitted when an <code>'error'</code> event is emitted by 2564an <code>Http2Session</code> object associated with the <code>Http2SecureServer</code>.</p> 2565<h5>Event: <code>'stream'</code><span><a class="mark" href="#event-stream_2" id="event-stream_2">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_stream_2"></a></h5> 2566<div class="api_metadata"> 2567<span>Added in: v8.4.0</span> 2568</div> 2569<ul> 2570<li><code>stream</code> <a href="http2.html#class-http2stream" class="type"><Http2Stream></a> A reference to the stream</li> 2571<li><code>headers</code> <a href="http2.html#headers-object" class="type"><HTTP/2 Headers Object></a> An object describing the headers</li> 2572<li><code>flags</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The associated numeric flags</li> 2573<li><code>rawHeaders</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="type"><Array></a> An array containing the raw header names followed by 2574their respective values.</li> 2575</ul> 2576<p>The <code>'stream'</code> event is emitted when a <code>'stream'</code> event has been emitted by 2577an <code>Http2Session</code> associated with the server.</p> 2578<p>See also <a href="#event-stream"><code>Http2Session</code>'s <code>'stream'</code> event</a>.</p> 2579<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 2580<span class="hljs-keyword">const</span> { 2581 <span class="hljs-title class_">HTTP2</span>_HEADER_METHOD, 2582 <span class="hljs-title class_">HTTP2</span>_HEADER_PATH, 2583 <span class="hljs-title class_">HTTP2</span>_HEADER_STATUS, 2584 <span class="hljs-title class_">HTTP2</span>_HEADER_CONTENT_TYPE, 2585} = http2.<span class="hljs-property">constants</span>; 2586 2587<span class="hljs-keyword">const</span> options = <span class="hljs-title function_">getOptionsSomehow</span>(); 2588 2589<span class="hljs-keyword">const</span> server = http2.<span class="hljs-title function_">createSecureServer</span>(options); 2590server.<span class="hljs-title function_">on</span>(<span class="hljs-string">'stream'</span>, <span class="hljs-function">(<span class="hljs-params">stream, headers, flags</span>) =></span> { 2591 <span class="hljs-keyword">const</span> method = headers[<span class="hljs-title class_">HTTP2</span>_HEADER_METHOD]; 2592 <span class="hljs-keyword">const</span> path = headers[<span class="hljs-title class_">HTTP2</span>_HEADER_PATH]; 2593 <span class="hljs-comment">// ...</span> 2594 stream.<span class="hljs-title function_">respond</span>({ 2595 [<span class="hljs-title class_">HTTP2</span>_HEADER_STATUS]: <span class="hljs-number">200</span>, 2596 [<span class="hljs-title class_">HTTP2</span>_HEADER_CONTENT_TYPE]: <span class="hljs-string">'text/plain; charset=utf-8'</span>, 2597 }); 2598 stream.<span class="hljs-title function_">write</span>(<span class="hljs-string">'hello '</span>); 2599 stream.<span class="hljs-title function_">end</span>(<span class="hljs-string">'world'</span>); 2600});</code> <button class="copy-button">copy</button></pre> 2601<h5>Event: <code>'timeout'</code><span><a class="mark" href="#event-timeout_3" id="event-timeout_3">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_timeout_3"></a></h5> 2602<div class="api_metadata"> 2603<span>Added in: v8.4.0</span> 2604</div> 2605<p>The <code>'timeout'</code> event is emitted when there is no activity on the Server for 2606a given number of milliseconds set using <code>http2secureServer.setTimeout()</code>. 2607<strong>Default:</strong> 2 minutes.</p> 2608<h5>Event: <code>'unknownProtocol'</code><span><a class="mark" href="#event-unknownprotocol" id="event-unknownprotocol">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_unknownprotocol"></a></h5> 2609<div class="api_metadata"> 2610<span>Added in: v8.4.0</span> 2611</div> 2612<ul> 2613<li><code>socket</code> <a href="stream.html#class-streamduplex" class="type"><stream.Duplex></a></li> 2614</ul> 2615<p>The <code>'unknownProtocol'</code> event is emitted when a connecting client fails to 2616negotiate an allowed protocol (i.e. HTTP/2 or HTTP/1.1). The event handler 2617receives the socket for handling. If no listener is registered for this event, 2618the connection is terminated. A timeout may be specified using the 2619<code>'unknownProtocolTimeout'</code> option passed to <a href="#http2createsecureserveroptions-onrequesthandler"><code>http2.createSecureServer()</code></a>. 2620See the <a href="#compatibility-api">Compatibility API</a>.</p> 2621<h5><code>server.close([callback])</code><span><a class="mark" href="#serverclosecallback_1" id="serverclosecallback_1">#</a></span><a aria-hidden="true" class="legacy" id="http2_server_close_callback_1"></a></h5> 2622<div class="api_metadata"> 2623<span>Added in: v8.4.0</span> 2624</div> 2625<ul> 2626<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 2627</ul> 2628<p>Stops the server from establishing new sessions. This does not prevent new 2629request streams from being created due to the persistent nature of HTTP/2 2630sessions. To gracefully shut down the server, call <a href="#http2sessionclosecallback"><code>http2session.close()</code></a> on 2631all active sessions.</p> 2632<p>If <code>callback</code> is provided, it is not invoked until all active sessions have been 2633closed, although the server has already stopped allowing new sessions. See 2634<a href="tls.html#serverclosecallback"><code>tls.Server.close()</code></a> for more details.</p> 2635<h5><code>server.setTimeout([msecs][, callback])</code><span><a class="mark" href="#serversettimeoutmsecs-callback_1" id="serversettimeoutmsecs-callback_1">#</a></span><a aria-hidden="true" class="legacy" id="http2_server_settimeout_msecs_callback_1"></a></h5> 2636<div class="api_metadata"> 2637<details class="changelog"><summary>History</summary> 2638<table> 2639<tbody><tr><th>Version</th><th>Changes</th></tr> 2640<tr><td>v18.0.0</td> 2641<td><p>Passing an invalid callback to the <code>callback</code> argument now throws <code>ERR_INVALID_ARG_TYPE</code> instead of <code>ERR_INVALID_CALLBACK</code>.</p></td></tr> 2642<tr><td>v8.4.0</td> 2643<td><p><span>Added in: v8.4.0</span></p></td></tr> 2644</tbody></table> 2645</details> 2646</div> 2647<ul> 2648<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> <code>120000</code> (2 minutes)</li> 2649<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 2650<li>Returns: <a href="http2.html#class-http2secureserver" class="type"><Http2SecureServer></a></li> 2651</ul> 2652<p>Used to set the timeout value for http2 secure server requests, 2653and sets a callback function that is called when there is no activity 2654on the <code>Http2SecureServer</code> after <code>msecs</code> milliseconds.</p> 2655<p>The given callback is registered as a listener on the <code>'timeout'</code> event.</p> 2656<p>In case if <code>callback</code> is not a function, a new <code>ERR_INVALID_ARG_TYPE</code> 2657error will be thrown.</p> 2658<h5><code>server.timeout</code><span><a class="mark" href="#servertimeout_1" id="servertimeout_1">#</a></span><a aria-hidden="true" class="legacy" id="http2_server_timeout_1"></a></h5> 2659<div class="api_metadata"> 2660<details class="changelog"><summary>History</summary> 2661<table> 2662<tbody><tr><th>Version</th><th>Changes</th></tr> 2663<tr><td>v13.0.0</td> 2664<td><p>The default timeout changed from 120s to 0 (no timeout).</p></td></tr> 2665<tr><td>v8.4.0</td> 2666<td><p><span>Added in: v8.4.0</span></p></td></tr> 2667</tbody></table> 2668</details> 2669</div> 2670<ul> 2671<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> 2672</ul> 2673<p>The number of milliseconds of inactivity before a socket is presumed 2674to have timed out.</p> 2675<p>A value of <code>0</code> will disable the timeout behavior on incoming connections.</p> 2676<p>The socket timeout logic is set up on connection, so changing this 2677value only affects new connections to the server, not any existing connections.</p> 2678<h5><code>server.updateSettings([settings])</code><span><a class="mark" href="#serverupdatesettingssettings_1" id="serverupdatesettingssettings_1">#</a></span><a aria-hidden="true" class="legacy" id="http2_server_updatesettings_settings_1"></a></h5> 2679<div class="api_metadata"> 2680<span>Added in: v15.1.0, v14.17.0</span> 2681</div> 2682<ul> 2683<li><code>settings</code> <a href="http2.html#settings-object" class="type"><HTTP/2 Settings Object></a></li> 2684</ul> 2685<p>Used to update the server with the provided settings.</p> 2686<p>Throws <code>ERR_HTTP2_INVALID_SETTING_VALUE</code> for invalid <code>settings</code> values.</p> 2687<p>Throws <code>ERR_INVALID_ARG_TYPE</code> for invalid <code>settings</code> argument.</p> 2688<h4><code>http2.createServer([options][, onRequestHandler])</code><span><a class="mark" href="#http2createserveroptions-onrequesthandler" id="http2createserveroptions-onrequesthandler">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2_createserver_options_onrequesthandler"></a></h4> 2689<div class="api_metadata"> 2690<details class="changelog"><summary>History</summary> 2691<table> 2692<tbody><tr><th>Version</th><th>Changes</th></tr> 2693<tr><td>v13.0.0</td> 2694<td><p>The <code>PADDING_STRATEGY_CALLBACK</code> has been made equivalent to providing <code>PADDING_STRATEGY_ALIGNED</code> and <code>selectPadding</code> has been removed.</p></td></tr> 2695<tr><td>v13.3.0, v12.16.0</td> 2696<td><p>Added <code>maxSessionRejectedStreams</code> option with a default of 100.</p></td></tr> 2697<tr><td>v13.3.0, v12.16.0</td> 2698<td><p>Added <code>maxSessionInvalidFrames</code> option with a default of 1000.</p></td></tr> 2699<tr><td>v12.4.0</td> 2700<td><p>The <code>options</code> parameter now supports <code>net.createServer()</code> options.</p></td></tr> 2701<tr><td>v15.10.0, v14.16.0, v12.21.0, v10.24.0</td> 2702<td><p>Added <code>unknownProtocolTimeout</code> option with a default of 10000.</p></td></tr> 2703<tr><td>v14.4.0, v12.18.0, v10.21.0</td> 2704<td><p>Added <code>maxSettings</code> option with a default of 32.</p></td></tr> 2705<tr><td>v9.6.0</td> 2706<td><p>Added the <code>Http1IncomingMessage</code> and <code>Http1ServerResponse</code> option.</p></td></tr> 2707<tr><td>v8.9.3</td> 2708<td><p>Added the <code>maxOutstandingPings</code> option with a default limit of 10.</p></td></tr> 2709<tr><td>v8.9.3</td> 2710<td><p>Added the <code>maxHeaderListPairs</code> option with a default limit of 128 header pairs.</p></td></tr> 2711<tr><td>v8.4.0</td> 2712<td><p><span>Added in: v8.4.0</span></p></td></tr> 2713</tbody></table> 2714</details> 2715</div> 2716<ul> 2717<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 2718<ul> 2719<li><code>maxDeflateDynamicTableSize</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Sets the maximum dynamic table size 2720for deflating header fields. <strong>Default:</strong> <code>4Kib</code>.</li> 2721<li><code>maxSettings</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Sets the maximum number of settings entries per 2722<code>SETTINGS</code> frame. The minimum value allowed is <code>1</code>. <strong>Default:</strong> <code>32</code>.</li> 2723<li><code>maxSessionMemory</code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Sets the maximum memory that the <code>Http2Session</code> 2724is permitted to use. The value is expressed in terms of number of megabytes, 2725e.g. <code>1</code> equal 1 megabyte. The minimum value allowed is <code>1</code>. 2726This is a credit based limit, existing <code>Http2Stream</code>s may cause this 2727limit to be exceeded, but new <code>Http2Stream</code> instances will be rejected 2728while this limit is exceeded. The current number of <code>Http2Stream</code> sessions, 2729the current memory use of the header compression tables, current data 2730queued to be sent, and unacknowledged <code>PING</code> and <code>SETTINGS</code> frames are all 2731counted towards the current limit. <strong>Default:</strong> <code>10</code>.</li> 2732<li><code>maxHeaderListPairs</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Sets the maximum number of header entries. 2733This is similar to <a href="http.html#servermaxheaderscount"><code>server.maxHeadersCount</code></a> or 2734<a href="http.html#requestmaxheaderscount"><code>request.maxHeadersCount</code></a> in the <code>node:http</code> module. The minimum value 2735is <code>4</code>. <strong>Default:</strong> <code>128</code>.</li> 2736<li><code>maxOutstandingPings</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Sets the maximum number of outstanding, 2737unacknowledged pings. <strong>Default:</strong> <code>10</code>.</li> 2738<li><code>maxSendHeaderBlockLength</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Sets the maximum allowed size for a 2739serialized, compressed block of headers. Attempts to send headers that 2740exceed this limit will result in a <code>'frameError'</code> event being emitted 2741and the stream being closed and destroyed. 2742While this sets the maximum allowed size to the entire block of headers, 2743<code>nghttp2</code> (the internal http2 library) has a limit of <code>65536</code> 2744for each decompressed key/value pair.</li> 2745<li><code>paddingStrategy</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The strategy used for determining the amount of 2746padding to use for <code>HEADERS</code> and <code>DATA</code> frames. <strong>Default:</strong> 2747<code>http2.constants.PADDING_STRATEGY_NONE</code>. Value may be one of: 2748<ul> 2749<li><code>http2.constants.PADDING_STRATEGY_NONE</code>: No padding is applied.</li> 2750<li><code>http2.constants.PADDING_STRATEGY_MAX</code>: The maximum amount of padding, 2751determined by the internal implementation, is applied.</li> 2752<li><code>http2.constants.PADDING_STRATEGY_ALIGNED</code>: Attempts to apply enough 2753padding to ensure that the total frame length, including the 9-byte 2754header, is a multiple of 8. For each frame, there is a maximum allowed 2755number of padding bytes that is determined by current flow control state 2756and settings. If this maximum is less than the calculated amount needed to 2757ensure alignment, the maximum is used and the total frame length is not 2758necessarily aligned at 8 bytes.</li> 2759</ul> 2760</li> 2761<li><code>peerMaxConcurrentStreams</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Sets the maximum number of concurrent 2762streams for the remote peer as if a <code>SETTINGS</code> frame had been received. Will 2763be overridden if the remote peer sets its own value for 2764<code>maxConcurrentStreams</code>. <strong>Default:</strong> <code>100</code>.</li> 2765<li><code>maxSessionInvalidFrames</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><integer></a> Sets the maximum number of invalid 2766frames that will be tolerated before the session is closed. 2767<strong>Default:</strong> <code>1000</code>.</li> 2768<li><code>maxSessionRejectedStreams</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><integer></a> Sets the maximum number of rejected 2769upon creation streams that will be tolerated before the session is closed. 2770Each rejection is associated with an <code>NGHTTP2_ENHANCE_YOUR_CALM</code> 2771error that should tell the peer to not open any more streams, continuing 2772to open streams is therefore regarded as a sign of a misbehaving peer. 2773<strong>Default:</strong> <code>100</code>.</li> 2774<li><code>settings</code> <a href="http2.html#settings-object" class="type"><HTTP/2 Settings Object></a> The initial settings to send to the 2775remote peer upon connection.</li> 2776<li><code>Http1IncomingMessage</code> <a href="http.html#class-httpincomingmessage" class="type"><http.IncomingMessage></a> Specifies the 2777<code>IncomingMessage</code> class to used for HTTP/1 fallback. Useful for extending 2778the original <code>http.IncomingMessage</code>. <strong>Default:</strong> <code>http.IncomingMessage</code>.</li> 2779<li><code>Http1ServerResponse</code> <a href="http.html#class-httpserverresponse" class="type"><http.ServerResponse></a> Specifies the <code>ServerResponse</code> 2780class to used for HTTP/1 fallback. Useful for extending the original 2781<code>http.ServerResponse</code>. <strong>Default:</strong> <code>http.ServerResponse</code>.</li> 2782<li><code>Http2ServerRequest</code> <a href="http2.html#class-http2http2serverrequest" class="type"><http2.Http2ServerRequest></a> Specifies the 2783<code>Http2ServerRequest</code> class to use. 2784Useful for extending the original <code>Http2ServerRequest</code>. 2785<strong>Default:</strong> <code>Http2ServerRequest</code>.</li> 2786<li><code>Http2ServerResponse</code> <a href="http2.html#class-http2http2serverresponse" class="type"><http2.Http2ServerResponse></a> Specifies the 2787<code>Http2ServerResponse</code> class to use. 2788Useful for extending the original <code>Http2ServerResponse</code>. 2789<strong>Default:</strong> <code>Http2ServerResponse</code>.</li> 2790<li><code>unknownProtocolTimeout</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Specifies a timeout in milliseconds that 2791a server should wait when an <a href="#event-unknownprotocol"><code>'unknownProtocol'</code></a> is emitted. If the 2792socket has not been destroyed by that time the server will destroy it. 2793<strong>Default:</strong> <code>10000</code>.</li> 2794<li>...: Any <a href="net.html#netcreateserveroptions-connectionlistener"><code>net.createServer()</code></a> option can be provided.</li> 2795</ul> 2796</li> 2797<li><code>onRequestHandler</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> See <a href="#compatibility-api">Compatibility API</a></li> 2798<li>Returns: <a href="http2.html#class-http2server" class="type"><Http2Server></a></li> 2799</ul> 2800<p>Returns a <code>net.Server</code> instance that creates and manages <code>Http2Session</code> 2801instances.</p> 2802<p>Since there are no browsers known that support 2803<a href="https://http2.github.io/faq/#does-http2-require-encryption">unencrypted HTTP/2</a>, the use of 2804<a href="#http2createsecureserveroptions-onrequesthandler"><code>http2.createSecureServer()</code></a> is necessary when communicating 2805with browser clients.</p> 2806<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 2807 2808<span class="hljs-comment">// Create an unencrypted HTTP/2 server.</span> 2809<span class="hljs-comment">// Since there are no browsers known that support</span> 2810<span class="hljs-comment">// unencrypted HTTP/2, the use of `http2.createSecureServer()`</span> 2811<span class="hljs-comment">// is necessary when communicating with browser clients.</span> 2812<span class="hljs-keyword">const</span> server = http2.<span class="hljs-title function_">createServer</span>(); 2813 2814server.<span class="hljs-title function_">on</span>(<span class="hljs-string">'stream'</span>, <span class="hljs-function">(<span class="hljs-params">stream, headers</span>) =></span> { 2815 stream.<span class="hljs-title function_">respond</span>({ 2816 <span class="hljs-string">'content-type'</span>: <span class="hljs-string">'text/html; charset=utf-8'</span>, 2817 <span class="hljs-string">':status'</span>: <span class="hljs-number">200</span>, 2818 }); 2819 stream.<span class="hljs-title function_">end</span>(<span class="hljs-string">'<h1>Hello World</h1>'</span>); 2820}); 2821 2822server.<span class="hljs-title function_">listen</span>(<span class="hljs-number">8000</span>);</code> <button class="copy-button">copy</button></pre> 2823<h4><code>http2.createSecureServer(options[, onRequestHandler])</code><span><a class="mark" href="#http2createsecureserveroptions-onrequesthandler" id="http2createsecureserveroptions-onrequesthandler">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2_createsecureserver_options_onrequesthandler"></a></h4> 2824<div class="api_metadata"> 2825<details class="changelog"><summary>History</summary> 2826<table> 2827<tbody><tr><th>Version</th><th>Changes</th></tr> 2828<tr><td>v13.0.0</td> 2829<td><p>The <code>PADDING_STRATEGY_CALLBACK</code> has been made equivalent to providing <code>PADDING_STRATEGY_ALIGNED</code> and <code>selectPadding</code> has been removed.</p></td></tr> 2830<tr><td>v13.3.0, v12.16.0</td> 2831<td><p>Added <code>maxSessionRejectedStreams</code> option with a default of 100.</p></td></tr> 2832<tr><td>v13.3.0, v12.16.0</td> 2833<td><p>Added <code>maxSessionInvalidFrames</code> option with a default of 1000.</p></td></tr> 2834<tr><td>v15.10.0, v14.16.0, v12.21.0, v10.24.0</td> 2835<td><p>Added <code>unknownProtocolTimeout</code> option with a default of 10000.</p></td></tr> 2836<tr><td>v14.4.0, v12.18.0, v10.21.0</td> 2837<td><p>Added <code>maxSettings</code> option with a default of 32.</p></td></tr> 2838<tr><td>v10.12.0</td> 2839<td><p>Added the <code>origins</code> option to automatically send an <code>ORIGIN</code> frame on <code>Http2Session</code> startup.</p></td></tr> 2840<tr><td>v8.9.3</td> 2841<td><p>Added the <code>maxOutstandingPings</code> option with a default limit of 10.</p></td></tr> 2842<tr><td>v8.9.3</td> 2843<td><p>Added the <code>maxHeaderListPairs</code> option with a default limit of 128 header pairs.</p></td></tr> 2844<tr><td>v8.4.0</td> 2845<td><p><span>Added in: v8.4.0</span></p></td></tr> 2846</tbody></table> 2847</details> 2848</div> 2849<ul> 2850<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 2851<ul> 2852<li><code>allowHTTP1</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> Incoming client connections that do not support 2853HTTP/2 will be downgraded to HTTP/1.x when set to <code>true</code>. 2854See the <a href="#event-unknownprotocol"><code>'unknownProtocol'</code></a> event. See <a href="#alpn-negotiation">ALPN negotiation</a>. 2855<strong>Default:</strong> <code>false</code>.</li> 2856<li><code>maxDeflateDynamicTableSize</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Sets the maximum dynamic table size 2857for deflating header fields. <strong>Default:</strong> <code>4Kib</code>.</li> 2858<li><code>maxSettings</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Sets the maximum number of settings entries per 2859<code>SETTINGS</code> frame. The minimum value allowed is <code>1</code>. <strong>Default:</strong> <code>32</code>.</li> 2860<li><code>maxSessionMemory</code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Sets the maximum memory that the <code>Http2Session</code> 2861is permitted to use. The value is expressed in terms of number of megabytes, 2862e.g. <code>1</code> equal 1 megabyte. The minimum value allowed is <code>1</code>. This is a 2863credit based limit, existing <code>Http2Stream</code>s may cause this 2864limit to be exceeded, but new <code>Http2Stream</code> instances will be rejected 2865while this limit is exceeded. The current number of <code>Http2Stream</code> sessions, 2866the current memory use of the header compression tables, current data 2867queued to be sent, and unacknowledged <code>PING</code> and <code>SETTINGS</code> frames are all 2868counted towards the current limit. <strong>Default:</strong> <code>10</code>.</li> 2869<li><code>maxHeaderListPairs</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Sets the maximum number of header entries. 2870This is similar to <a href="http.html#servermaxheaderscount"><code>server.maxHeadersCount</code></a> or 2871<a href="http.html#requestmaxheaderscount"><code>request.maxHeadersCount</code></a> in the <code>node:http</code> module. The minimum value 2872is <code>4</code>. <strong>Default:</strong> <code>128</code>.</li> 2873<li><code>maxOutstandingPings</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Sets the maximum number of outstanding, 2874unacknowledged pings. <strong>Default:</strong> <code>10</code>.</li> 2875<li><code>maxSendHeaderBlockLength</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Sets the maximum allowed size for a 2876serialized, compressed block of headers. Attempts to send headers that 2877exceed this limit will result in a <code>'frameError'</code> event being emitted 2878and the stream being closed and destroyed.</li> 2879<li><code>paddingStrategy</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Strategy used for determining the amount of 2880padding to use for <code>HEADERS</code> and <code>DATA</code> frames. <strong>Default:</strong> 2881<code>http2.constants.PADDING_STRATEGY_NONE</code>. Value may be one of: 2882<ul> 2883<li><code>http2.constants.PADDING_STRATEGY_NONE</code>: No padding is applied.</li> 2884<li><code>http2.constants.PADDING_STRATEGY_MAX</code>: The maximum amount of padding, 2885determined by the internal implementation, is applied.</li> 2886<li><code>http2.constants.PADDING_STRATEGY_ALIGNED</code>: Attempts to apply enough 2887padding to ensure that the total frame length, including the 28889-byte header, is a multiple of 8. For each frame, there is a maximum 2889allowed number of padding bytes that is determined by current flow control 2890state and settings. If this maximum is less than the calculated amount 2891needed to ensure alignment, the maximum is used and the total frame length 2892is not necessarily aligned at 8 bytes.</li> 2893</ul> 2894</li> 2895<li><code>peerMaxConcurrentStreams</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Sets the maximum number of concurrent 2896streams for the remote peer as if a <code>SETTINGS</code> frame had been received. Will 2897be overridden if the remote peer sets its own value for 2898<code>maxConcurrentStreams</code>. <strong>Default:</strong> <code>100</code>.</li> 2899<li><code>maxSessionInvalidFrames</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><integer></a> Sets the maximum number of invalid 2900frames that will be tolerated before the session is closed. 2901<strong>Default:</strong> <code>1000</code>.</li> 2902<li><code>maxSessionRejectedStreams</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><integer></a> Sets the maximum number of rejected 2903upon creation streams that will be tolerated before the session is closed. 2904Each rejection is associated with an <code>NGHTTP2_ENHANCE_YOUR_CALM</code> 2905error that should tell the peer to not open any more streams, continuing 2906to open streams is therefore regarded as a sign of a misbehaving peer. 2907<strong>Default:</strong> <code>100</code>.</li> 2908<li><code>settings</code> <a href="http2.html#settings-object" class="type"><HTTP/2 Settings Object></a> The initial settings to send to the 2909remote peer upon connection.</li> 2910<li>...: Any <a href="tls.html#tlscreateserveroptions-secureconnectionlistener"><code>tls.createServer()</code></a> options can be provided. For 2911servers, the identity options (<code>pfx</code> or <code>key</code>/<code>cert</code>) are usually required.</li> 2912<li><code>origins</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string[]></a> An array of origin strings to send within an <code>ORIGIN</code> 2913frame immediately following creation of a new server <code>Http2Session</code>.</li> 2914<li><code>unknownProtocolTimeout</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Specifies a timeout in milliseconds that 2915a server should wait when an <a href="#event-unknownprotocol"><code>'unknownProtocol'</code></a> event is emitted. If 2916the socket has not been destroyed by that time the server will destroy it. 2917<strong>Default:</strong> <code>10000</code>.</li> 2918</ul> 2919</li> 2920<li><code>onRequestHandler</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> See <a href="#compatibility-api">Compatibility API</a></li> 2921<li>Returns: <a href="http2.html#class-http2secureserver" class="type"><Http2SecureServer></a></li> 2922</ul> 2923<p>Returns a <code>tls.Server</code> instance that creates and manages <code>Http2Session</code> 2924instances.</p> 2925<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 2926<span class="hljs-keyword">const</span> fs = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:fs'</span>); 2927 2928<span class="hljs-keyword">const</span> options = { 2929 <span class="hljs-attr">key</span>: fs.<span class="hljs-title function_">readFileSync</span>(<span class="hljs-string">'server-key.pem'</span>), 2930 <span class="hljs-attr">cert</span>: fs.<span class="hljs-title function_">readFileSync</span>(<span class="hljs-string">'server-cert.pem'</span>), 2931}; 2932 2933<span class="hljs-comment">// Create a secure HTTP/2 server</span> 2934<span class="hljs-keyword">const</span> server = http2.<span class="hljs-title function_">createSecureServer</span>(options); 2935 2936server.<span class="hljs-title function_">on</span>(<span class="hljs-string">'stream'</span>, <span class="hljs-function">(<span class="hljs-params">stream, headers</span>) =></span> { 2937 stream.<span class="hljs-title function_">respond</span>({ 2938 <span class="hljs-string">'content-type'</span>: <span class="hljs-string">'text/html; charset=utf-8'</span>, 2939 <span class="hljs-string">':status'</span>: <span class="hljs-number">200</span>, 2940 }); 2941 stream.<span class="hljs-title function_">end</span>(<span class="hljs-string">'<h1>Hello World</h1>'</span>); 2942}); 2943 2944server.<span class="hljs-title function_">listen</span>(<span class="hljs-number">8443</span>);</code> <button class="copy-button">copy</button></pre> 2945<h4><code>http2.connect(authority[, options][, listener])</code><span><a class="mark" href="#http2connectauthority-options-listener" id="http2connectauthority-options-listener">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2_connect_authority_options_listener"></a></h4> 2946<div class="api_metadata"> 2947<details class="changelog"><summary>History</summary> 2948<table> 2949<tbody><tr><th>Version</th><th>Changes</th></tr> 2950<tr><td>v13.0.0</td> 2951<td><p>The <code>PADDING_STRATEGY_CALLBACK</code> has been made equivalent to providing <code>PADDING_STRATEGY_ALIGNED</code> and <code>selectPadding</code> has been removed.</p></td></tr> 2952<tr><td>v15.10.0, v14.16.0, v12.21.0, v10.24.0</td> 2953<td><p>Added <code>unknownProtocolTimeout</code> option with a default of 10000.</p></td></tr> 2954<tr><td>v14.4.0, v12.18.0, v10.21.0</td> 2955<td><p>Added <code>maxSettings</code> option with a default of 32.</p></td></tr> 2956<tr><td>v8.9.3</td> 2957<td><p>Added the <code>maxOutstandingPings</code> option with a default limit of 10.</p></td></tr> 2958<tr><td>v8.9.3</td> 2959<td><p>Added the <code>maxHeaderListPairs</code> option with a default limit of 128 header pairs.</p></td></tr> 2960<tr><td>v8.4.0</td> 2961<td><p><span>Added in: v8.4.0</span></p></td></tr> 2962</tbody></table> 2963</details> 2964</div> 2965<ul> 2966<li><code>authority</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> | <a href="url.html#the-whatwg-url-api" class="type"><URL></a> The remote HTTP/2 server to connect to. This must 2967be in the form of a minimal, valid URL with the <code>http://</code> or <code>https://</code> 2968prefix, host name, and IP port (if a non-default port is used). Userinfo 2969(user ID and password), path, querystring, and fragment details in the 2970URL will be ignored.</li> 2971<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 2972<ul> 2973<li><code>maxDeflateDynamicTableSize</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Sets the maximum dynamic table size 2974for deflating header fields. <strong>Default:</strong> <code>4Kib</code>.</li> 2975<li><code>maxSettings</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Sets the maximum number of settings entries per 2976<code>SETTINGS</code> frame. The minimum value allowed is <code>1</code>. <strong>Default:</strong> <code>32</code>.</li> 2977<li><code>maxSessionMemory</code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Sets the maximum memory that the <code>Http2Session</code> 2978is permitted to use. The value is expressed in terms of number of megabytes, 2979e.g. <code>1</code> equal 1 megabyte. The minimum value allowed is <code>1</code>. 2980This is a credit based limit, existing <code>Http2Stream</code>s may cause this 2981limit to be exceeded, but new <code>Http2Stream</code> instances will be rejected 2982while this limit is exceeded. The current number of <code>Http2Stream</code> sessions, 2983the current memory use of the header compression tables, current data 2984queued to be sent, and unacknowledged <code>PING</code> and <code>SETTINGS</code> frames are all 2985counted towards the current limit. <strong>Default:</strong> <code>10</code>.</li> 2986<li><code>maxHeaderListPairs</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Sets the maximum number of header entries. 2987This is similar to <a href="http.html#servermaxheaderscount"><code>server.maxHeadersCount</code></a> or 2988<a href="http.html#requestmaxheaderscount"><code>request.maxHeadersCount</code></a> in the <code>node:http</code> module. The minimum value 2989is <code>1</code>. <strong>Default:</strong> <code>128</code>.</li> 2990<li><code>maxOutstandingPings</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Sets the maximum number of outstanding, 2991unacknowledged pings. <strong>Default:</strong> <code>10</code>.</li> 2992<li><code>maxReservedRemoteStreams</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Sets the maximum number of reserved push 2993streams the client will accept at any given time. Once the current number of 2994currently reserved push streams exceeds reaches this limit, new push streams 2995sent by the server will be automatically rejected. The minimum allowed value 2996is 0. The maximum allowed value is 2<sup>32</sup>-1. A negative value sets 2997this option to the maximum allowed value. <strong>Default:</strong> <code>200</code>.</li> 2998<li><code>maxSendHeaderBlockLength</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Sets the maximum allowed size for a 2999serialized, compressed block of headers. Attempts to send headers that 3000exceed this limit will result in a <code>'frameError'</code> event being emitted 3001and the stream being closed and destroyed.</li> 3002<li><code>paddingStrategy</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Strategy used for determining the amount of 3003padding to use for <code>HEADERS</code> and <code>DATA</code> frames. <strong>Default:</strong> 3004<code>http2.constants.PADDING_STRATEGY_NONE</code>. Value may be one of: 3005<ul> 3006<li><code>http2.constants.PADDING_STRATEGY_NONE</code>: No padding is applied.</li> 3007<li><code>http2.constants.PADDING_STRATEGY_MAX</code>: The maximum amount of padding, 3008determined by the internal implementation, is applied.</li> 3009<li><code>http2.constants.PADDING_STRATEGY_ALIGNED</code>: Attempts to apply enough 3010padding to ensure that the total frame length, including the 30119-byte header, is a multiple of 8. For each frame, there is a maximum 3012allowed number of padding bytes that is determined by current flow control 3013state and settings. If this maximum is less than the calculated amount 3014needed to ensure alignment, the maximum is used and the total frame length 3015is not necessarily aligned at 8 bytes.</li> 3016</ul> 3017</li> 3018<li><code>peerMaxConcurrentStreams</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Sets the maximum number of concurrent 3019streams for the remote peer as if a <code>SETTINGS</code> frame had been received. Will 3020be overridden if the remote peer sets its own value for 3021<code>maxConcurrentStreams</code>. <strong>Default:</strong> <code>100</code>.</li> 3022<li><code>protocol</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> The protocol to connect with, if not set in the 3023<code>authority</code>. Value may be either <code>'http:'</code> or <code>'https:'</code>. <strong>Default:</strong> 3024<code>'https:'</code></li> 3025<li><code>settings</code> <a href="http2.html#settings-object" class="type"><HTTP/2 Settings Object></a> The initial settings to send to the 3026remote peer upon connection.</li> 3027<li><code>createConnection</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> An optional callback that receives the <code>URL</code> 3028instance passed to <code>connect</code> and the <code>options</code> object, and returns any 3029<a href="stream.html#class-streamduplex"><code>Duplex</code></a> stream that is to be used as the connection for this session.</li> 3030<li>...: Any <a href="net.html#netconnect"><code>net.connect()</code></a> or <a href="tls.html#tlsconnectoptions-callback"><code>tls.connect()</code></a> options can be provided.</li> 3031<li><code>unknownProtocolTimeout</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Specifies a timeout in milliseconds that 3032a server should wait when an <a href="#event-unknownprotocol"><code>'unknownProtocol'</code></a> event is emitted. If 3033the socket has not been destroyed by that time the server will destroy it. 3034<strong>Default:</strong> <code>10000</code>.</li> 3035</ul> 3036</li> 3037<li><code>listener</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> Will be registered as a one-time listener of the 3038<a href="#event-connect"><code>'connect'</code></a> event.</li> 3039<li>Returns: <a href="http2.html#class-clienthttp2session" class="type"><ClientHttp2Session></a></li> 3040</ul> 3041<p>Returns a <code>ClientHttp2Session</code> instance.</p> 3042<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 3043<span class="hljs-keyword">const</span> client = http2.<span class="hljs-title function_">connect</span>(<span class="hljs-string">'https://localhost:1234'</span>); 3044 3045<span class="hljs-comment">/* Use the client */</span> 3046 3047client.<span class="hljs-title function_">close</span>();</code> <button class="copy-button">copy</button></pre> 3048<h4><code>http2.constants</code><span><a class="mark" href="#http2constants" id="http2constants">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2_constants"></a></h4> 3049<div class="api_metadata"> 3050<span>Added in: v8.4.0</span> 3051</div> 3052<h5>Error codes for <code>RST_STREAM</code> and <code>GOAWAY</code><span><a class="mark" href="#error-codes-for-rst_stream-and-goaway" id="error-codes-for-rst_stream-and-goaway">#</a></span><a aria-hidden="true" class="legacy" id="http2_error_codes_for_rst_stream_and_goaway"></a></h5> 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133<table><thead><tr><th>Value</th><th>Name</th><th>Constant</th></tr></thead><tbody><tr><td><code>0x00</code></td><td>No Error</td><td><code>http2.constants.NGHTTP2_NO_ERROR</code></td></tr><tr><td><code>0x01</code></td><td>Protocol Error</td><td><code>http2.constants.NGHTTP2_PROTOCOL_ERROR</code></td></tr><tr><td><code>0x02</code></td><td>Internal Error</td><td><code>http2.constants.NGHTTP2_INTERNAL_ERROR</code></td></tr><tr><td><code>0x03</code></td><td>Flow Control Error</td><td><code>http2.constants.NGHTTP2_FLOW_CONTROL_ERROR</code></td></tr><tr><td><code>0x04</code></td><td>Settings Timeout</td><td><code>http2.constants.NGHTTP2_SETTINGS_TIMEOUT</code></td></tr><tr><td><code>0x05</code></td><td>Stream Closed</td><td><code>http2.constants.NGHTTP2_STREAM_CLOSED</code></td></tr><tr><td><code>0x06</code></td><td>Frame Size Error</td><td><code>http2.constants.NGHTTP2_FRAME_SIZE_ERROR</code></td></tr><tr><td><code>0x07</code></td><td>Refused Stream</td><td><code>http2.constants.NGHTTP2_REFUSED_STREAM</code></td></tr><tr><td><code>0x08</code></td><td>Cancel</td><td><code>http2.constants.NGHTTP2_CANCEL</code></td></tr><tr><td><code>0x09</code></td><td>Compression Error</td><td><code>http2.constants.NGHTTP2_COMPRESSION_ERROR</code></td></tr><tr><td><code>0x0a</code></td><td>Connect Error</td><td><code>http2.constants.NGHTTP2_CONNECT_ERROR</code></td></tr><tr><td><code>0x0b</code></td><td>Enhance Your Calm</td><td><code>http2.constants.NGHTTP2_ENHANCE_YOUR_CALM</code></td></tr><tr><td><code>0x0c</code></td><td>Inadequate Security</td><td><code>http2.constants.NGHTTP2_INADEQUATE_SECURITY</code></td></tr><tr><td><code>0x0d</code></td><td>HTTP/1.1 Required</td><td><code>http2.constants.NGHTTP2_HTTP_1_1_REQUIRED</code></td></tr></tbody></table> 3134<p>The <code>'timeout'</code> event is emitted when there is no activity on the Server for 3135a given number of milliseconds set using <code>http2server.setTimeout()</code>.</p> 3136<h4><code>http2.getDefaultSettings()</code><span><a class="mark" href="#http2getdefaultsettings" id="http2getdefaultsettings">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2_getdefaultsettings"></a></h4> 3137<div class="api_metadata"> 3138<span>Added in: v8.4.0</span> 3139</div> 3140<ul> 3141<li>Returns: <a href="http2.html#settings-object" class="type"><HTTP/2 Settings Object></a></li> 3142</ul> 3143<p>Returns an object containing the default settings for an <code>Http2Session</code> 3144instance. This method returns a new object instance every time it is called 3145so instances returned may be safely modified for use.</p> 3146<h4><code>http2.getPackedSettings([settings])</code><span><a class="mark" href="#http2getpackedsettingssettings" id="http2getpackedsettingssettings">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2_getpackedsettings_settings"></a></h4> 3147<div class="api_metadata"> 3148<span>Added in: v8.4.0</span> 3149</div> 3150<ul> 3151<li><code>settings</code> <a href="http2.html#settings-object" class="type"><HTTP/2 Settings Object></a></li> 3152<li>Returns: <a href="buffer.html#class-buffer" class="type"><Buffer></a></li> 3153</ul> 3154<p>Returns a <code>Buffer</code> instance containing serialized representation of the given 3155HTTP/2 settings as specified in the <a href="https://tools.ietf.org/html/rfc7540">HTTP/2</a> specification. This is intended 3156for use with the <code>HTTP2-Settings</code> header field.</p> 3157<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 3158 3159<span class="hljs-keyword">const</span> packed = http2.<span class="hljs-title function_">getPackedSettings</span>({ <span class="hljs-attr">enablePush</span>: <span class="hljs-literal">false</span> }); 3160 3161<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(packed.<span class="hljs-title function_">toString</span>(<span class="hljs-string">'base64'</span>)); 3162<span class="hljs-comment">// Prints: AAIAAAAA</span></code> <button class="copy-button">copy</button></pre> 3163<h4><code>http2.getUnpackedSettings(buf)</code><span><a class="mark" href="#http2getunpackedsettingsbuf" id="http2getunpackedsettingsbuf">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2_getunpackedsettings_buf"></a></h4> 3164<div class="api_metadata"> 3165<span>Added in: v8.4.0</span> 3166</div> 3167<ul> 3168<li><code>buf</code> <a href="buffer.html#class-buffer" class="type"><Buffer></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray" class="type"><TypedArray></a> The packed settings.</li> 3169<li>Returns: <a href="http2.html#settings-object" class="type"><HTTP/2 Settings Object></a></li> 3170</ul> 3171<p>Returns a <a href="#settings-object">HTTP/2 Settings Object</a> containing the deserialized settings from 3172the given <code>Buffer</code> as generated by <code>http2.getPackedSettings()</code>.</p> 3173<h4><code>http2.sensitiveHeaders</code><span><a class="mark" href="#http2sensitiveheaders" id="http2sensitiveheaders">#</a></span><a aria-hidden="true" class="legacy" id="http2_http2_sensitiveheaders"></a></h4> 3174<div class="api_metadata"> 3175<span>Added in: v15.0.0, v14.18.0</span> 3176</div> 3177<ul> 3178<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Symbol_type" class="type"><symbol></a></li> 3179</ul> 3180<p>This symbol can be set as a property on the HTTP/2 headers object with an array 3181value in order to provide a list of headers considered sensitive. 3182See <a href="#sensitive-headers">Sensitive headers</a> for more details.</p> 3183<h4>Headers object<span><a class="mark" href="#headers-object" id="headers-object">#</a></span><a aria-hidden="true" class="legacy" id="http2_headers_object"></a></h4> 3184<p>Headers are represented as own-properties on JavaScript objects. The property 3185keys will be serialized to lower-case. Property values should be strings (if 3186they are not they will be coerced to strings) or an <code>Array</code> of strings (in order 3187to send more than one value per header field).</p> 3188<pre><code class="language-js"><span class="hljs-keyword">const</span> headers = { 3189 <span class="hljs-string">':status'</span>: <span class="hljs-string">'200'</span>, 3190 <span class="hljs-string">'content-type'</span>: <span class="hljs-string">'text-plain'</span>, 3191 <span class="hljs-string">'ABC'</span>: [<span class="hljs-string">'has'</span>, <span class="hljs-string">'more'</span>, <span class="hljs-string">'than'</span>, <span class="hljs-string">'one'</span>, <span class="hljs-string">'value'</span>], 3192}; 3193 3194stream.<span class="hljs-title function_">respond</span>(headers);</code> <button class="copy-button">copy</button></pre> 3195<p>Header objects passed to callback functions will have a <code>null</code> prototype. This 3196means that normal JavaScript object methods such as 3197<code>Object.prototype.toString()</code> and <code>Object.prototype.hasOwnProperty()</code> will 3198not work.</p> 3199<p>For incoming headers:</p> 3200<ul> 3201<li>The <code>:status</code> header is converted to <code>number</code>.</li> 3202<li>Duplicates of <code>:status</code>, <code>:method</code>, <code>:authority</code>, <code>:scheme</code>, <code>:path</code>, 3203<code>:protocol</code>, <code>age</code>, <code>authorization</code>, <code>access-control-allow-credentials</code>, 3204<code>access-control-max-age</code>, <code>access-control-request-method</code>, <code>content-encoding</code>, 3205<code>content-language</code>, <code>content-length</code>, <code>content-location</code>, <code>content-md5</code>, 3206<code>content-range</code>, <code>content-type</code>, <code>date</code>, <code>dnt</code>, <code>etag</code>, <code>expires</code>, <code>from</code>, 3207<code>host</code>, <code>if-match</code>, <code>if-modified-since</code>, <code>if-none-match</code>, <code>if-range</code>, 3208<code>if-unmodified-since</code>, <code>last-modified</code>, <code>location</code>, <code>max-forwards</code>, 3209<code>proxy-authorization</code>, <code>range</code>, <code>referer</code>,<code>retry-after</code>, <code>tk</code>, 3210<code>upgrade-insecure-requests</code>, <code>user-agent</code> or <code>x-content-type-options</code> are 3211discarded.</li> 3212<li><code>set-cookie</code> is always an array. Duplicates are added to the array.</li> 3213<li>For duplicate <code>cookie</code> headers, the values are joined together with '; '.</li> 3214<li>For all other headers, the values are joined together with ', '.</li> 3215</ul> 3216<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 3217<span class="hljs-keyword">const</span> server = http2.<span class="hljs-title function_">createServer</span>(); 3218server.<span class="hljs-title function_">on</span>(<span class="hljs-string">'stream'</span>, <span class="hljs-function">(<span class="hljs-params">stream, headers</span>) =></span> { 3219 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(headers[<span class="hljs-string">':path'</span>]); 3220 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(headers.<span class="hljs-property">ABC</span>); 3221});</code> <button class="copy-button">copy</button></pre> 3222<h5>Sensitive headers<span><a class="mark" href="#sensitive-headers" id="sensitive-headers">#</a></span><a aria-hidden="true" class="legacy" id="http2_sensitive_headers"></a></h5> 3223<p>HTTP2 headers can be marked as sensitive, which means that the HTTP/2 3224header compression algorithm will never index them. This can make sense for 3225header values with low entropy and that may be considered valuable to an 3226attacker, for example <code>Cookie</code> or <code>Authorization</code>. To achieve this, add 3227the header name to the <code>[http2.sensitiveHeaders]</code> property as an array:</p> 3228<pre><code class="language-js"><span class="hljs-keyword">const</span> headers = { 3229 <span class="hljs-string">':status'</span>: <span class="hljs-string">'200'</span>, 3230 <span class="hljs-string">'content-type'</span>: <span class="hljs-string">'text-plain'</span>, 3231 <span class="hljs-string">'cookie'</span>: <span class="hljs-string">'some-cookie'</span>, 3232 <span class="hljs-string">'other-sensitive-header'</span>: <span class="hljs-string">'very secret data'</span>, 3233 [http2.<span class="hljs-property">sensitiveHeaders</span>]: [<span class="hljs-string">'cookie'</span>, <span class="hljs-string">'other-sensitive-header'</span>], 3234}; 3235 3236stream.<span class="hljs-title function_">respond</span>(headers);</code> <button class="copy-button">copy</button></pre> 3237<p>For some headers, such as <code>Authorization</code> and short <code>Cookie</code> headers, 3238this flag is set automatically.</p> 3239<p>This property is also set for received headers. It will contain the names of 3240all headers marked as sensitive, including ones marked that way automatically.</p> 3241<h4>Settings object<span><a class="mark" href="#settings-object" id="settings-object">#</a></span><a aria-hidden="true" class="legacy" id="http2_settings_object"></a></h4> 3242<div class="api_metadata"> 3243<details class="changelog"><summary>History</summary> 3244<table> 3245<tbody><tr><th>Version</th><th>Changes</th></tr> 3246<tr><td>v12.12.0</td> 3247<td><p>The <code>maxConcurrentStreams</code> setting is stricter.</p></td></tr> 3248<tr><td>v8.9.3</td> 3249<td><p>The <code>maxHeaderListSize</code> setting is now strictly enforced.</p></td></tr> 3250<tr><td>v8.4.0</td> 3251<td><p><span>Added in: v8.4.0</span></p></td></tr> 3252</tbody></table> 3253</details> 3254</div> 3255<p>The <code>http2.getDefaultSettings()</code>, <code>http2.getPackedSettings()</code>, 3256<code>http2.createServer()</code>, <code>http2.createSecureServer()</code>, 3257<code>http2session.settings()</code>, <code>http2session.localSettings</code>, and 3258<code>http2session.remoteSettings</code> APIs either return or receive as input an 3259object that defines configuration settings for an <code>Http2Session</code> object. 3260These objects are ordinary JavaScript objects containing the following 3261properties.</p> 3262<ul> 3263<li><code>headerTableSize</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Specifies the maximum number of bytes used for 3264header compression. The minimum allowed value is 0. The maximum allowed value 3265is 2<sup>32</sup>-1. <strong>Default:</strong> <code>4096</code>.</li> 3266<li><code>enablePush</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> Specifies <code>true</code> if HTTP/2 Push Streams are to be 3267permitted on the <code>Http2Session</code> instances. <strong>Default:</strong> <code>true</code>.</li> 3268<li><code>initialWindowSize</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Specifies the <em>sender's</em> initial window size in 3269bytes for stream-level flow control. The minimum allowed value is 0. The 3270maximum allowed value is 2<sup>32</sup>-1. <strong>Default:</strong> <code>65535</code>.</li> 3271<li><code>maxFrameSize</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Specifies the size in bytes of the largest frame 3272payload. The minimum allowed value is 16,384. The maximum allowed value is 32732<sup>24</sup>-1. <strong>Default:</strong> <code>16384</code>.</li> 3274<li><code>maxConcurrentStreams</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Specifies the maximum number of concurrent 3275streams permitted on an <code>Http2Session</code>. There is no default value which 3276implies, at least theoretically, 2<sup>32</sup>-1 streams may be open 3277concurrently at any given time in an <code>Http2Session</code>. The minimum value 3278is 0. The maximum allowed value is 2<sup>32</sup>-1. <strong>Default:</strong> 3279<code>4294967295</code>.</li> 3280<li><code>maxHeaderListSize</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Specifies the maximum size (uncompressed octets) 3281of header list that will be accepted. The minimum allowed value is 0. The 3282maximum allowed value is 2<sup>32</sup>-1. <strong>Default:</strong> <code>65535</code>.</li> 3283<li><code>maxHeaderSize</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Alias for <code>maxHeaderListSize</code>.</li> 3284<li><code>enableConnectProtocol</code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> Specifies <code>true</code> if the "Extended Connect 3285Protocol" defined by <a href="https://tools.ietf.org/html/rfc8441">RFC 8441</a> is to be enabled. This setting is only 3286meaningful if sent by the server. Once the <code>enableConnectProtocol</code> setting 3287has been enabled for a given <code>Http2Session</code>, it cannot be disabled. 3288<strong>Default:</strong> <code>false</code>.</li> 3289</ul> 3290<p>All additional properties on the settings object are ignored.</p> 3291<h4>Error handling<span><a class="mark" href="#error-handling" id="error-handling">#</a></span><a aria-hidden="true" class="legacy" id="http2_error_handling"></a></h4> 3292<p>There are several types of error conditions that may arise when using the 3293<code>node:http2</code> module:</p> 3294<p>Validation errors occur when an incorrect argument, option, or setting value is 3295passed in. These will always be reported by a synchronous <code>throw</code>.</p> 3296<p>State errors occur when an action is attempted at an incorrect time (for 3297instance, attempting to send data on a stream after it has closed). These will 3298be reported using either a synchronous <code>throw</code> or via an <code>'error'</code> event on 3299the <code>Http2Stream</code>, <code>Http2Session</code> or HTTP/2 Server objects, depending on where 3300and when the error occurs.</p> 3301<p>Internal errors occur when an HTTP/2 session fails unexpectedly. These will be 3302reported via an <code>'error'</code> event on the <code>Http2Session</code> or HTTP/2 Server objects.</p> 3303<p>Protocol errors occur when various HTTP/2 protocol constraints are violated. 3304These will be reported using either a synchronous <code>throw</code> or via an <code>'error'</code> 3305event on the <code>Http2Stream</code>, <code>Http2Session</code> or HTTP/2 Server objects, depending 3306on where and when the error occurs.</p> 3307<h4>Invalid character handling in header names and values<span><a class="mark" href="#invalid-character-handling-in-header-names-and-values" id="invalid-character-handling-in-header-names-and-values">#</a></span><a aria-hidden="true" class="legacy" id="http2_invalid_character_handling_in_header_names_and_values"></a></h4> 3308<p>The HTTP/2 implementation applies stricter handling of invalid characters in 3309HTTP header names and values than the HTTP/1 implementation.</p> 3310<p>Header field names are <em>case-insensitive</em> and are transmitted over the wire 3311strictly as lower-case strings. The API provided by Node.js allows header 3312names to be set as mixed-case strings (e.g. <code>Content-Type</code>) but will convert 3313those to lower-case (e.g. <code>content-type</code>) upon transmission.</p> 3314<p>Header field-names <em>must only</em> contain one or more of the following ASCII 3315characters: <code>a</code>-<code>z</code>, <code>A</code>-<code>Z</code>, <code>0</code>-<code>9</code>, <code>!</code>, <code>#</code>, <code>$</code>, <code>%</code>, <code>&</code>, <code>'</code>, <code>*</code>, <code>+</code>, 3316<code>-</code>, <code>.</code>, <code>^</code>, <code>_</code>, <code>`</code> (backtick), <code>|</code>, and <code>~</code>.</p> 3317<p>Using invalid characters within an HTTP header field name will cause the 3318stream to be closed with a protocol error being reported.</p> 3319<p>Header field values are handled with more leniency but <em>should</em> not contain 3320new-line or carriage return characters and <em>should</em> be limited to US-ASCII 3321characters, per the requirements of the HTTP specification.</p> 3322<h4>Push streams on the client<span><a class="mark" href="#push-streams-on-the-client" id="push-streams-on-the-client">#</a></span><a aria-hidden="true" class="legacy" id="http2_push_streams_on_the_client"></a></h4> 3323<p>To receive pushed streams on the client, set a listener for the <code>'stream'</code> 3324event on the <code>ClientHttp2Session</code>:</p> 3325<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 3326 3327<span class="hljs-keyword">const</span> client = http2.<span class="hljs-title function_">connect</span>(<span class="hljs-string">'http://localhost'</span>); 3328 3329client.<span class="hljs-title function_">on</span>(<span class="hljs-string">'stream'</span>, <span class="hljs-function">(<span class="hljs-params">pushedStream, requestHeaders</span>) =></span> { 3330 pushedStream.<span class="hljs-title function_">on</span>(<span class="hljs-string">'push'</span>, <span class="hljs-function">(<span class="hljs-params">responseHeaders</span>) =></span> { 3331 <span class="hljs-comment">// Process response headers</span> 3332 }); 3333 pushedStream.<span class="hljs-title function_">on</span>(<span class="hljs-string">'data'</span>, <span class="hljs-function">(<span class="hljs-params">chunk</span>) =></span> { <span class="hljs-comment">/* handle pushed data */</span> }); 3334}); 3335 3336<span class="hljs-keyword">const</span> req = client.<span class="hljs-title function_">request</span>({ <span class="hljs-string">':path'</span>: <span class="hljs-string">'/'</span> });</code> <button class="copy-button">copy</button></pre> 3337<h4>Supporting the <code>CONNECT</code> method<span><a class="mark" href="#supporting-the-connect-method" id="supporting-the-connect-method">#</a></span><a aria-hidden="true" class="legacy" id="http2_supporting_the_connect_method"></a></h4> 3338<p>The <code>CONNECT</code> method is used to allow an HTTP/2 server to be used as a proxy 3339for TCP/IP connections.</p> 3340<p>A simple TCP Server:</p> 3341<pre><code class="language-js"><span class="hljs-keyword">const</span> net = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:net'</span>); 3342 3343<span class="hljs-keyword">const</span> server = net.<span class="hljs-title function_">createServer</span>(<span class="hljs-function">(<span class="hljs-params">socket</span>) =></span> { 3344 <span class="hljs-keyword">let</span> name = <span class="hljs-string">''</span>; 3345 socket.<span class="hljs-title function_">setEncoding</span>(<span class="hljs-string">'utf8'</span>); 3346 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> name += chunk); 3347 socket.<span class="hljs-title function_">on</span>(<span class="hljs-string">'end'</span>, <span class="hljs-function">() =></span> socket.<span class="hljs-title function_">end</span>(<span class="hljs-string">`hello <span class="hljs-subst">${name}</span>`</span>)); 3348}); 3349 3350server.<span class="hljs-title function_">listen</span>(<span class="hljs-number">8000</span>);</code> <button class="copy-button">copy</button></pre> 3351<p>An HTTP/2 CONNECT proxy:</p> 3352<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 3353<span class="hljs-keyword">const</span> { <span class="hljs-title class_">NGHTTP2</span>_REFUSED_STREAM } = http2.<span class="hljs-property">constants</span>; 3354<span class="hljs-keyword">const</span> net = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:net'</span>); 3355 3356<span class="hljs-keyword">const</span> proxy = http2.<span class="hljs-title function_">createServer</span>(); 3357proxy.<span class="hljs-title function_">on</span>(<span class="hljs-string">'stream'</span>, <span class="hljs-function">(<span class="hljs-params">stream, headers</span>) =></span> { 3358 <span class="hljs-keyword">if</span> (headers[<span class="hljs-string">':method'</span>] !== <span class="hljs-string">'CONNECT'</span>) { 3359 <span class="hljs-comment">// Only accept CONNECT requests</span> 3360 stream.<span class="hljs-title function_">close</span>(<span class="hljs-title class_">NGHTTP2</span>_REFUSED_STREAM); 3361 <span class="hljs-keyword">return</span>; 3362 } 3363 <span class="hljs-keyword">const</span> auth = <span class="hljs-keyword">new</span> <span class="hljs-title function_">URL</span>(<span class="hljs-string">`tcp://<span class="hljs-subst">${headers[<span class="hljs-string">':authority'</span>]}</span>`</span>); 3364 <span class="hljs-comment">// It's a very good idea to verify that hostname and port are</span> 3365 <span class="hljs-comment">// things this proxy should be connecting to.</span> 3366 <span class="hljs-keyword">const</span> socket = net.<span class="hljs-title function_">connect</span>(auth.<span class="hljs-property">port</span>, auth.<span class="hljs-property">hostname</span>, <span class="hljs-function">() =></span> { 3367 stream.<span class="hljs-title function_">respond</span>(); 3368 socket.<span class="hljs-title function_">pipe</span>(stream); 3369 stream.<span class="hljs-title function_">pipe</span>(socket); 3370 }); 3371 socket.<span class="hljs-title function_">on</span>(<span class="hljs-string">'error'</span>, <span class="hljs-function">(<span class="hljs-params">error</span>) =></span> { 3372 stream.<span class="hljs-title function_">close</span>(http2.<span class="hljs-property">constants</span>.<span class="hljs-property">NGHTTP2_CONNECT_ERROR</span>); 3373 }); 3374}); 3375 3376proxy.<span class="hljs-title function_">listen</span>(<span class="hljs-number">8001</span>);</code> <button class="copy-button">copy</button></pre> 3377<p>An HTTP/2 CONNECT client:</p> 3378<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 3379 3380<span class="hljs-keyword">const</span> client = http2.<span class="hljs-title function_">connect</span>(<span class="hljs-string">'http://localhost:8001'</span>); 3381 3382<span class="hljs-comment">// Must not specify the ':path' and ':scheme' headers</span> 3383<span class="hljs-comment">// for CONNECT requests or an error will be thrown.</span> 3384<span class="hljs-keyword">const</span> req = client.<span class="hljs-title function_">request</span>({ 3385 <span class="hljs-string">':method'</span>: <span class="hljs-string">'CONNECT'</span>, 3386 <span class="hljs-string">':authority'</span>: <span class="hljs-string">'localhost:8000'</span>, 3387}); 3388 3389req.<span class="hljs-title function_">on</span>(<span class="hljs-string">'response'</span>, <span class="hljs-function">(<span class="hljs-params">headers</span>) =></span> { 3390 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(headers[http2.<span class="hljs-property">constants</span>.<span class="hljs-property">HTTP2_HEADER_STATUS</span>]); 3391}); 3392<span class="hljs-keyword">let</span> data = <span class="hljs-string">''</span>; 3393req.<span class="hljs-title function_">setEncoding</span>(<span class="hljs-string">'utf8'</span>); 3394req.<span class="hljs-title function_">on</span>(<span class="hljs-string">'data'</span>, <span class="hljs-function">(<span class="hljs-params">chunk</span>) =></span> data += chunk); 3395req.<span class="hljs-title function_">on</span>(<span class="hljs-string">'end'</span>, <span class="hljs-function">() =></span> { 3396 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">`The server says: <span class="hljs-subst">${data}</span>`</span>); 3397 client.<span class="hljs-title function_">close</span>(); 3398}); 3399req.<span class="hljs-title function_">end</span>(<span class="hljs-string">'Jane'</span>);</code> <button class="copy-button">copy</button></pre> 3400<h4>The extended <code>CONNECT</code> protocol<span><a class="mark" href="#the-extended-connect-protocol" id="the-extended-connect-protocol">#</a></span><a aria-hidden="true" class="legacy" id="http2_the_extended_connect_protocol"></a></h4> 3401<p><a href="https://tools.ietf.org/html/rfc8441">RFC 8441</a> defines an "Extended CONNECT Protocol" extension to HTTP/2 that 3402may be used to bootstrap the use of an <code>Http2Stream</code> using the <code>CONNECT</code> 3403method as a tunnel for other communication protocols (such as WebSockets).</p> 3404<p>The use of the Extended CONNECT Protocol is enabled by HTTP/2 servers by using 3405the <code>enableConnectProtocol</code> setting:</p> 3406<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 3407<span class="hljs-keyword">const</span> settings = { <span class="hljs-attr">enableConnectProtocol</span>: <span class="hljs-literal">true</span> }; 3408<span class="hljs-keyword">const</span> server = http2.<span class="hljs-title function_">createServer</span>({ settings });</code> <button class="copy-button">copy</button></pre> 3409<p>Once the client receives the <code>SETTINGS</code> frame from the server indicating that 3410the extended CONNECT may be used, it may send <code>CONNECT</code> requests that use the 3411<code>':protocol'</code> HTTP/2 pseudo-header:</p> 3412<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 3413<span class="hljs-keyword">const</span> client = http2.<span class="hljs-title function_">connect</span>(<span class="hljs-string">'http://localhost:8080'</span>); 3414client.<span class="hljs-title function_">on</span>(<span class="hljs-string">'remoteSettings'</span>, <span class="hljs-function">(<span class="hljs-params">settings</span>) =></span> { 3415 <span class="hljs-keyword">if</span> (settings.<span class="hljs-property">enableConnectProtocol</span>) { 3416 <span class="hljs-keyword">const</span> req = client.<span class="hljs-title function_">request</span>({ <span class="hljs-string">':method'</span>: <span class="hljs-string">'CONNECT'</span>, <span class="hljs-string">':protocol'</span>: <span class="hljs-string">'foo'</span> }); 3417 <span class="hljs-comment">// ...</span> 3418 } 3419});</code> <button class="copy-button">copy</button></pre> 3420</section><section><h3>Compatibility API<span><a class="mark" href="#compatibility-api" id="compatibility-api">#</a></span><a aria-hidden="true" class="legacy" id="http2_compatibility_api"></a></h3> 3421<p>The Compatibility API has the goal of providing a similar developer experience 3422of HTTP/1 when using HTTP/2, making it possible to develop applications 3423that support both <a href="http.html">HTTP/1</a> and HTTP/2. This API targets only the 3424<strong>public API</strong> of the <a href="http.html">HTTP/1</a>. However many modules use internal 3425methods or state, and those <em>are not supported</em> as it is a completely 3426different implementation.</p> 3427<p>The following example creates an HTTP/2 server using the compatibility 3428API:</p> 3429<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 3430<span class="hljs-keyword">const</span> server = http2.<span class="hljs-title function_">createServer</span>(<span class="hljs-function">(<span class="hljs-params">req, res</span>) =></span> { 3431 res.<span class="hljs-title function_">setHeader</span>(<span class="hljs-string">'Content-Type'</span>, <span class="hljs-string">'text/html'</span>); 3432 res.<span class="hljs-title function_">setHeader</span>(<span class="hljs-string">'X-Foo'</span>, <span class="hljs-string">'bar'</span>); 3433 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; charset=utf-8'</span> }); 3434 res.<span class="hljs-title function_">end</span>(<span class="hljs-string">'ok'</span>); 3435});</code> <button class="copy-button">copy</button></pre> 3436<p>In order to create a mixed <a href="https.html">HTTPS</a> and HTTP/2 server, refer to the 3437<a href="#alpn-negotiation">ALPN negotiation</a> section. 3438Upgrading from non-tls HTTP/1 servers is not supported.</p> 3439<p>The HTTP/2 compatibility API is composed of <a href="#class-http2http2serverrequest"><code>Http2ServerRequest</code></a> and 3440<a href="#class-http2http2serverresponse"><code>Http2ServerResponse</code></a>. They aim at API compatibility with HTTP/1, but 3441they do not hide the differences between the protocols. As an example, 3442the status message for HTTP codes is ignored.</p> 3443<h4>ALPN negotiation<span><a class="mark" href="#alpn-negotiation" id="alpn-negotiation">#</a></span><a aria-hidden="true" class="legacy" id="http2_alpn_negotiation"></a></h4> 3444<p>ALPN negotiation allows supporting both <a href="https.html">HTTPS</a> and HTTP/2 over 3445the same socket. The <code>req</code> and <code>res</code> objects can be either HTTP/1 or 3446HTTP/2, and an application <strong>must</strong> restrict itself to the public API of 3447<a href="http.html">HTTP/1</a>, and detect if it is possible to use the more advanced 3448features of HTTP/2.</p> 3449<p>The following example creates a server that supports both protocols:</p> 3450<pre><code class="language-js"><span class="hljs-keyword">const</span> { createSecureServer } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 3451<span class="hljs-keyword">const</span> { readFileSync } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:fs'</span>); 3452 3453<span class="hljs-keyword">const</span> cert = <span class="hljs-title function_">readFileSync</span>(<span class="hljs-string">'./cert.pem'</span>); 3454<span class="hljs-keyword">const</span> key = <span class="hljs-title function_">readFileSync</span>(<span class="hljs-string">'./key.pem'</span>); 3455 3456<span class="hljs-keyword">const</span> server = <span class="hljs-title function_">createSecureServer</span>( 3457 { cert, key, <span class="hljs-attr">allowHTTP1</span>: <span class="hljs-literal">true</span> }, 3458 onRequest, 3459).<span class="hljs-title function_">listen</span>(<span class="hljs-number">4443</span>); 3460 3461<span class="hljs-keyword">function</span> <span class="hljs-title function_">onRequest</span>(<span class="hljs-params">req, res</span>) { 3462 <span class="hljs-comment">// Detects if it is a HTTPS request or HTTP/2</span> 3463 <span class="hljs-keyword">const</span> { <span class="hljs-attr">socket</span>: { alpnProtocol } } = req.<span class="hljs-property">httpVersion</span> === <span class="hljs-string">'2.0'</span> ? 3464 req.<span class="hljs-property">stream</span>.<span class="hljs-property">session</span> : req; 3465 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> }); 3466 res.<span class="hljs-title function_">end</span>(<span class="hljs-title class_">JSON</span>.<span class="hljs-title function_">stringify</span>({ 3467 alpnProtocol, 3468 <span class="hljs-attr">httpVersion</span>: req.<span class="hljs-property">httpVersion</span>, 3469 })); 3470}</code> <button class="copy-button">copy</button></pre> 3471<p>The <code>'request'</code> event works identically on both <a href="https.html">HTTPS</a> and 3472HTTP/2.</p> 3473<h4>Class: <code>http2.Http2ServerRequest</code><span><a class="mark" href="#class-http2http2serverrequest" id="class-http2http2serverrequest">#</a></span><a aria-hidden="true" class="legacy" id="http2_class_http2_http2serverrequest"></a></h4> 3474<div class="api_metadata"> 3475<span>Added in: v8.4.0</span> 3476</div> 3477<ul> 3478<li>Extends: <a href="stream.html#class-streamreadable" class="type"><stream.Readable></a></li> 3479</ul> 3480<p>A <code>Http2ServerRequest</code> object is created by <a href="#class-http2server"><code>http2.Server</code></a> or 3481<a href="#class-http2secureserver"><code>http2.SecureServer</code></a> and passed as the first argument to the 3482<a href="#event-request"><code>'request'</code></a> event. It may be used to access a request status, headers, and 3483data.</p> 3484<h5>Event: <code>'aborted'</code><span><a class="mark" href="#event-aborted_1" id="event-aborted_1">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_aborted_1"></a></h5> 3485<div class="api_metadata"> 3486<span>Added in: v8.4.0</span> 3487</div> 3488<p>The <code>'aborted'</code> event is emitted whenever a <code>Http2ServerRequest</code> instance is 3489abnormally aborted in mid-communication.</p> 3490<p>The <code>'aborted'</code> event will only be emitted if the <code>Http2ServerRequest</code> writable 3491side has not been ended.</p> 3492<h5>Event: <code>'close'</code><span><a class="mark" href="#event-close_2" id="event-close_2">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_close_2"></a></h5> 3493<div class="api_metadata"> 3494<span>Added in: v8.4.0</span> 3495</div> 3496<p>Indicates that the underlying <a href="#class-http2stream"><code>Http2Stream</code></a> was closed. 3497Just like <code>'end'</code>, this event occurs only once per response.</p> 3498<h5><code>request.aborted</code><span><a class="mark" href="#requestaborted" id="requestaborted">#</a></span><a aria-hidden="true" class="legacy" id="http2_request_aborted"></a></h5> 3499<div class="api_metadata"> 3500<span>Added in: v10.1.0</span> 3501</div> 3502<ul> 3503<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 3504</ul> 3505<p>The <code>request.aborted</code> property will be <code>true</code> if the request has 3506been aborted.</p> 3507<h5><code>request.authority</code><span><a class="mark" href="#requestauthority" id="requestauthority">#</a></span><a aria-hidden="true" class="legacy" id="http2_request_authority"></a></h5> 3508<div class="api_metadata"> 3509<span>Added in: v8.4.0</span> 3510</div> 3511<ul> 3512<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3513</ul> 3514<p>The request authority pseudo header field. Because HTTP/2 allows requests 3515to set either <code>:authority</code> or <code>host</code>, this value is derived from 3516<code>req.headers[':authority']</code> if present. Otherwise, it is derived from 3517<code>req.headers['host']</code>.</p> 3518<h5><code>request.complete</code><span><a class="mark" href="#requestcomplete" id="requestcomplete">#</a></span><a aria-hidden="true" class="legacy" id="http2_request_complete"></a></h5> 3519<div class="api_metadata"> 3520<span>Added in: v12.10.0</span> 3521</div> 3522<ul> 3523<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 3524</ul> 3525<p>The <code>request.complete</code> property will be <code>true</code> if the request has 3526been completed, aborted, or destroyed.</p> 3527<h5><code>request.connection</code><span><a class="mark" href="#requestconnection" id="requestconnection">#</a></span><a aria-hidden="true" class="legacy" id="http2_request_connection"></a></h5> 3528<div class="api_metadata"> 3529<span>Added in: v8.4.0</span><span>Deprecated since: v13.0.0</span> 3530</div> 3531<p></p><div class="api_stability api_stability_0"><a href="documentation.html#stability-index">Stability: 0</a> - Deprecated. Use <a href="#requestsocket"><code>request.socket</code></a>.</div><p></p> 3532<ul> 3533<li><a href="net.html#class-netsocket" class="type"><net.Socket></a> | <a href="tls.html#class-tlstlssocket" class="type"><tls.TLSSocket></a></li> 3534</ul> 3535<p>See <a href="#requestsocket"><code>request.socket</code></a>.</p> 3536<h5><code>request.destroy([error])</code><span><a class="mark" href="#requestdestroyerror" id="requestdestroyerror">#</a></span><a aria-hidden="true" class="legacy" id="http2_request_destroy_error"></a></h5> 3537<div class="api_metadata"> 3538<span>Added in: v8.4.0</span> 3539</div> 3540<ul> 3541<li><code>error</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" class="type"><Error></a></li> 3542</ul> 3543<p>Calls <code>destroy()</code> on the <a href="#class-http2stream"><code>Http2Stream</code></a> that received 3544the <a href="#class-http2http2serverrequest"><code>Http2ServerRequest</code></a>. If <code>error</code> is provided, an <code>'error'</code> event 3545is emitted and <code>error</code> is passed as an argument to any listeners on the event.</p> 3546<p>It does nothing if the stream was already destroyed.</p> 3547<h5><code>request.headers</code><span><a class="mark" href="#requestheaders" id="requestheaders">#</a></span><a aria-hidden="true" class="legacy" id="http2_request_headers"></a></h5> 3548<div class="api_metadata"> 3549<span>Added in: v8.4.0</span> 3550</div> 3551<ul> 3552<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 3553</ul> 3554<p>The request/response headers object.</p> 3555<p>Key-value pairs of header names and values. Header names are lower-cased.</p> 3556<pre><code class="language-js"><span class="hljs-comment">// Prints something like:</span> 3557<span class="hljs-comment">//</span> 3558<span class="hljs-comment">// { 'user-agent': 'curl/7.22.0',</span> 3559<span class="hljs-comment">// host: '127.0.0.1:8000',</span> 3560<span class="hljs-comment">// accept: '*/*' }</span> 3561<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(request.<span class="hljs-property">headers</span>);</code> <button class="copy-button">copy</button></pre> 3562<p>See <a href="#headers-object">HTTP/2 Headers Object</a>.</p> 3563<p>In HTTP/2, the request path, host name, protocol, and method are represented as 3564special headers prefixed with the <code>:</code> character (e.g. <code>':path'</code>). These special 3565headers will be included in the <code>request.headers</code> object. Care must be taken not 3566to inadvertently modify these special headers or errors may occur. For instance, 3567removing all headers from the request will cause errors to occur:</p> 3568<pre><code class="language-js"><span class="hljs-title function_">removeAllHeaders</span>(request.<span class="hljs-property">headers</span>); 3569<span class="hljs-title function_">assert</span>(request.<span class="hljs-property">url</span>); <span class="hljs-comment">// Fails because the :path header has been removed</span></code> <button class="copy-button">copy</button></pre> 3570<h5><code>request.httpVersion</code><span><a class="mark" href="#requesthttpversion" id="requesthttpversion">#</a></span><a aria-hidden="true" class="legacy" id="http2_request_httpversion"></a></h5> 3571<div class="api_metadata"> 3572<span>Added in: v8.4.0</span> 3573</div> 3574<ul> 3575<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3576</ul> 3577<p>In case of server request, the HTTP version sent by the client. In the case of 3578client response, the HTTP version of the connected-to server. Returns 3579<code>'2.0'</code>.</p> 3580<p>Also <code>message.httpVersionMajor</code> is the first integer and 3581<code>message.httpVersionMinor</code> is the second.</p> 3582<h5><code>request.method</code><span><a class="mark" href="#requestmethod" id="requestmethod">#</a></span><a aria-hidden="true" class="legacy" id="http2_request_method"></a></h5> 3583<div class="api_metadata"> 3584<span>Added in: v8.4.0</span> 3585</div> 3586<ul> 3587<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3588</ul> 3589<p>The request method as a string. Read-only. Examples: <code>'GET'</code>, <code>'DELETE'</code>.</p> 3590<h5><code>request.rawHeaders</code><span><a class="mark" href="#requestrawheaders" id="requestrawheaders">#</a></span><a aria-hidden="true" class="legacy" id="http2_request_rawheaders"></a></h5> 3591<div class="api_metadata"> 3592<span>Added in: v8.4.0</span> 3593</div> 3594<ul> 3595<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string[]></a></li> 3596</ul> 3597<p>The raw request/response headers list exactly as they were received.</p> 3598<p>The keys and values are in the same list. It is <em>not</em> a 3599list of tuples. So, the even-numbered offsets are key values, and the 3600odd-numbered offsets are the associated values.</p> 3601<p>Header names are not lowercased, and duplicates are not merged.</p> 3602<pre><code class="language-js"><span class="hljs-comment">// Prints something like:</span> 3603<span class="hljs-comment">//</span> 3604<span class="hljs-comment">// [ 'user-agent',</span> 3605<span class="hljs-comment">// 'this is invalid because there can be only one',</span> 3606<span class="hljs-comment">// 'User-Agent',</span> 3607<span class="hljs-comment">// 'curl/7.22.0',</span> 3608<span class="hljs-comment">// 'Host',</span> 3609<span class="hljs-comment">// '127.0.0.1:8000',</span> 3610<span class="hljs-comment">// 'ACCEPT',</span> 3611<span class="hljs-comment">// '*/*' ]</span> 3612<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(request.<span class="hljs-property">rawHeaders</span>);</code> <button class="copy-button">copy</button></pre> 3613<h5><code>request.rawTrailers</code><span><a class="mark" href="#requestrawtrailers" id="requestrawtrailers">#</a></span><a aria-hidden="true" class="legacy" id="http2_request_rawtrailers"></a></h5> 3614<div class="api_metadata"> 3615<span>Added in: v8.4.0</span> 3616</div> 3617<ul> 3618<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string[]></a></li> 3619</ul> 3620<p>The raw request/response trailer keys and values exactly as they were 3621received. Only populated at the <code>'end'</code> event.</p> 3622<h5><code>request.scheme</code><span><a class="mark" href="#requestscheme" id="requestscheme">#</a></span><a aria-hidden="true" class="legacy" id="http2_request_scheme"></a></h5> 3623<div class="api_metadata"> 3624<span>Added in: v8.4.0</span> 3625</div> 3626<ul> 3627<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3628</ul> 3629<p>The request scheme pseudo header field indicating the scheme 3630portion of the target URL.</p> 3631<h5><code>request.setTimeout(msecs, callback)</code><span><a class="mark" href="#requestsettimeoutmsecs-callback" id="requestsettimeoutmsecs-callback">#</a></span><a aria-hidden="true" class="legacy" id="http2_request_settimeout_msecs_callback"></a></h5> 3632<div class="api_metadata"> 3633<span>Added in: v8.4.0</span> 3634</div> 3635<ul> 3636<li><code>msecs</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 3637<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 3638<li>Returns: <a href="http2.html#class-http2http2serverrequest" class="type"><http2.Http2ServerRequest></a></li> 3639</ul> 3640<p>Sets the <a href="#class-http2stream"><code>Http2Stream</code></a>'s timeout value to <code>msecs</code>. If a callback is 3641provided, then it is added as a listener on the <code>'timeout'</code> event on 3642the response object.</p> 3643<p>If no <code>'timeout'</code> listener is added to the request, the response, or 3644the server, then <a href="#class-http2stream"><code>Http2Stream</code></a>s are destroyed when they time out. If a 3645handler is assigned to the request, the response, or the server's <code>'timeout'</code> 3646events, timed out sockets must be handled explicitly.</p> 3647<h5><code>request.socket</code><span><a class="mark" href="#requestsocket" id="requestsocket">#</a></span><a aria-hidden="true" class="legacy" id="http2_request_socket"></a></h5> 3648<div class="api_metadata"> 3649<span>Added in: v8.4.0</span> 3650</div> 3651<ul> 3652<li><a href="net.html#class-netsocket" class="type"><net.Socket></a> | <a href="tls.html#class-tlstlssocket" class="type"><tls.TLSSocket></a></li> 3653</ul> 3654<p>Returns a <code>Proxy</code> object that acts as a <code>net.Socket</code> (or <code>tls.TLSSocket</code>) but 3655applies getters, setters, and methods based on HTTP/2 logic.</p> 3656<p><code>destroyed</code>, <code>readable</code>, and <code>writable</code> properties will be retrieved from and 3657set on <code>request.stream</code>.</p> 3658<p><code>destroy</code>, <code>emit</code>, <code>end</code>, <code>on</code> and <code>once</code> methods will be called on 3659<code>request.stream</code>.</p> 3660<p><code>setTimeout</code> method will be called on <code>request.stream.session</code>.</p> 3661<p><code>pause</code>, <code>read</code>, <code>resume</code>, and <code>write</code> will throw an error with code 3662<code>ERR_HTTP2_NO_SOCKET_MANIPULATION</code>. See <a href="#http2session-and-sockets"><code>Http2Session</code> and Sockets</a> for 3663more information.</p> 3664<p>All other interactions will be routed directly to the socket. With TLS support, 3665use <a href="tls.html#tlssocketgetpeercertificatedetailed"><code>request.socket.getPeerCertificate()</code></a> to obtain the client's 3666authentication details.</p> 3667<h5><code>request.stream</code><span><a class="mark" href="#requeststream" id="requeststream">#</a></span><a aria-hidden="true" class="legacy" id="http2_request_stream"></a></h5> 3668<div class="api_metadata"> 3669<span>Added in: v8.4.0</span> 3670</div> 3671<ul> 3672<li><a href="http2.html#class-http2stream" class="type"><Http2Stream></a></li> 3673</ul> 3674<p>The <a href="#class-http2stream"><code>Http2Stream</code></a> object backing the request.</p> 3675<h5><code>request.trailers</code><span><a class="mark" href="#requesttrailers" id="requesttrailers">#</a></span><a aria-hidden="true" class="legacy" id="http2_request_trailers"></a></h5> 3676<div class="api_metadata"> 3677<span>Added in: v8.4.0</span> 3678</div> 3679<ul> 3680<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 3681</ul> 3682<p>The request/response trailers object. Only populated at the <code>'end'</code> event.</p> 3683<h5><code>request.url</code><span><a class="mark" href="#requesturl" id="requesturl">#</a></span><a aria-hidden="true" class="legacy" id="http2_request_url"></a></h5> 3684<div class="api_metadata"> 3685<span>Added in: v8.4.0</span> 3686</div> 3687<ul> 3688<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3689</ul> 3690<p>Request URL string. This contains only the URL that is present in the actual 3691HTTP request. If the request is:</p> 3692<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> 3693<span class="hljs-attribute">Accept</span><span class="hljs-punctuation">: </span>text/plain</code> <button class="copy-button">copy</button></pre> 3694<p>Then <code>request.url</code> will be:</p> 3695<!-- eslint-disable semi --> 3696<pre><code class="language-js"><span class="hljs-string">'/status?name=ryan'</span></code> <button class="copy-button">copy</button></pre> 3697<p>To parse the url into its parts, <code>new URL()</code> can be used:</p> 3698<pre><code class="language-console"><span class="hljs-meta prompt_">$ </span><span class="language-bash">node</span> 3699<span class="hljs-meta prompt_">> </span><span class="language-bash">new URL(<span class="hljs-string">'/status?name=ryan'</span>, <span class="hljs-string">'http://example.com'</span>)</span> 3700URL { 3701 href: 'http://example.com/status?name=ryan', 3702 origin: 'http://example.com', 3703 protocol: 'http:', 3704 username: '', 3705 password: '', 3706 host: 'example.com', 3707 hostname: 'example.com', 3708 port: '', 3709 pathname: '/status', 3710 search: '?name=ryan', 3711 searchParams: URLSearchParams { 'name' => 'ryan' }, 3712 hash: '' 3713}</code> <button class="copy-button">copy</button></pre> 3714<h4>Class: <code>http2.Http2ServerResponse</code><span><a class="mark" href="#class-http2http2serverresponse" id="class-http2http2serverresponse">#</a></span><a aria-hidden="true" class="legacy" id="http2_class_http2_http2serverresponse"></a></h4> 3715<div class="api_metadata"> 3716<span>Added in: v8.4.0</span> 3717</div> 3718<ul> 3719<li>Extends: <a href="stream.html#stream" class="type"><Stream></a></li> 3720</ul> 3721<p>This object is created internally by an HTTP server, not by the user. It is 3722passed as the second parameter to the <a href="#event-request"><code>'request'</code></a> event.</p> 3723<h5>Event: <code>'close'</code><span><a class="mark" href="#event-close_3" id="event-close_3">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_close_3"></a></h5> 3724<div class="api_metadata"> 3725<span>Added in: v8.4.0</span> 3726</div> 3727<p>Indicates that the underlying <a href="#class-http2stream"><code>Http2Stream</code></a> was terminated before 3728<a href="#responseenddata-encoding-callback"><code>response.end()</code></a> was called or able to flush.</p> 3729<h5>Event: <code>'finish'</code><span><a class="mark" href="#event-finish" id="event-finish">#</a></span><a aria-hidden="true" class="legacy" id="http2_event_finish"></a></h5> 3730<div class="api_metadata"> 3731<span>Added in: v8.4.0</span> 3732</div> 3733<p>Emitted when the response has been sent. More specifically, this event is 3734emitted when the last segment of the response headers and body have been 3735handed off to the HTTP/2 multiplexing for transmission over the network. It 3736does not imply that the client has received anything yet.</p> 3737<p>After this event, no more events will be emitted on the response object.</p> 3738<h5><code>response.addTrailers(headers)</code><span><a class="mark" href="#responseaddtrailersheaders" id="responseaddtrailersheaders">#</a></span><a aria-hidden="true" class="legacy" id="http2_response_addtrailers_headers"></a></h5> 3739<div class="api_metadata"> 3740<span>Added in: v8.4.0</span> 3741</div> 3742<ul> 3743<li><code>headers</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 3744</ul> 3745<p>This method adds HTTP trailing headers (a header but at the end of the 3746message) to the response.</p> 3747<p>Attempting to set a header field name or value that contains invalid characters 3748will result in a <a href="errors.html#class-typeerror"><code>TypeError</code></a> being thrown.</p> 3749<h5><code>response.connection</code><span><a class="mark" href="#responseconnection" id="responseconnection">#</a></span><a aria-hidden="true" class="legacy" id="http2_response_connection"></a></h5> 3750<div class="api_metadata"> 3751<span>Added in: v8.4.0</span><span>Deprecated since: v13.0.0</span> 3752</div> 3753<p></p><div class="api_stability api_stability_0"><a href="documentation.html#stability-index">Stability: 0</a> - Deprecated. Use <a href="#responsesocket"><code>response.socket</code></a>.</div><p></p> 3754<ul> 3755<li><a href="net.html#class-netsocket" class="type"><net.Socket></a> | <a href="tls.html#class-tlstlssocket" class="type"><tls.TLSSocket></a></li> 3756</ul> 3757<p>See <a href="#responsesocket"><code>response.socket</code></a>.</p> 3758<h5><code>response.createPushResponse(headers, callback)</code><span><a class="mark" href="#responsecreatepushresponseheaders-callback" id="responsecreatepushresponseheaders-callback">#</a></span><a aria-hidden="true" class="legacy" id="http2_response_createpushresponse_headers_callback"></a></h5> 3759<div class="api_metadata"> 3760<details class="changelog"><summary>History</summary> 3761<table> 3762<tbody><tr><th>Version</th><th>Changes</th></tr> 3763<tr><td>v18.0.0</td> 3764<td><p>Passing an invalid callback to the <code>callback</code> argument now throws <code>ERR_INVALID_ARG_TYPE</code> instead of <code>ERR_INVALID_CALLBACK</code>.</p></td></tr> 3765<tr><td>v8.4.0</td> 3766<td><p><span>Added in: v8.4.0</span></p></td></tr> 3767</tbody></table> 3768</details> 3769</div> 3770<ul> 3771<li><code>headers</code> <a href="http2.html#headers-object" class="type"><HTTP/2 Headers Object></a> An object describing the headers</li> 3772<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> Called once <code>http2stream.pushStream()</code> is finished, 3773or either when the attempt to create the pushed <code>Http2Stream</code> has failed or 3774has been rejected, or the state of <code>Http2ServerRequest</code> is closed prior to 3775calling the <code>http2stream.pushStream()</code> method 3776<ul> 3777<li><code>err</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" class="type"><Error></a></li> 3778<li><code>res</code> <a href="http2.html#class-http2http2serverresponse" class="type"><http2.Http2ServerResponse></a> The newly-created <code>Http2ServerResponse</code> 3779object</li> 3780</ul> 3781</li> 3782</ul> 3783<p>Call <a href="#http2streampushstreamheaders-options-callback"><code>http2stream.pushStream()</code></a> with the given headers, and wrap the 3784given <a href="#class-http2stream"><code>Http2Stream</code></a> on a newly created <code>Http2ServerResponse</code> as the callback 3785parameter if successful. When <code>Http2ServerRequest</code> is closed, the callback is 3786called with an error <code>ERR_HTTP2_INVALID_STREAM</code>.</p> 3787<h5><code>response.end([data[, encoding]][, callback])</code><span><a class="mark" href="#responseenddata-encoding-callback" id="responseenddata-encoding-callback">#</a></span><a aria-hidden="true" class="legacy" id="http2_response_end_data_encoding_callback"></a></h5> 3788<div class="api_metadata"> 3789<details class="changelog"><summary>History</summary> 3790<table> 3791<tbody><tr><th>Version</th><th>Changes</th></tr> 3792<tr><td>v10.0.0</td> 3793<td><p>This method now returns a reference to <code>ServerResponse</code>.</p></td></tr> 3794<tr><td>v8.4.0</td> 3795<td><p><span>Added in: v8.4.0</span></p></td></tr> 3796</tbody></table> 3797</details> 3798</div> 3799<ul> 3800<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#class-buffer" class="type"><Buffer></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array" class="type"><Uint8Array></a></li> 3801<li><code>encoding</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3802<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 3803<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/this" class="type"><this></a></li> 3804</ul> 3805<p>This method signals to the server that all of the response headers and body 3806have been sent; that server should consider this message complete. 3807The method, <code>response.end()</code>, MUST be called on each response.</p> 3808<p>If <code>data</code> is specified, it is equivalent to calling 3809<a href="http.html#responsewritechunk-encoding-callback"><code>response.write(data, encoding)</code></a> followed by <code>response.end(callback)</code>.</p> 3810<p>If <code>callback</code> is specified, it will be called when the response stream 3811is finished.</p> 3812<h5><code>response.finished</code><span><a class="mark" href="#responsefinished" id="responsefinished">#</a></span><a aria-hidden="true" class="legacy" id="http2_response_finished"></a></h5> 3813<div class="api_metadata"> 3814<span>Added in: v8.4.0</span><span>Deprecated since: v13.4.0, v12.16.0</span> 3815</div> 3816<p></p><div class="api_stability api_stability_0"><a href="documentation.html#stability-index">Stability: 0</a> - Deprecated. Use <a href="#responsewritableended"><code>response.writableEnded</code></a>.</div><p></p> 3817<ul> 3818<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 3819</ul> 3820<p>Boolean value that indicates whether the response has completed. Starts 3821as <code>false</code>. After <a href="#responseenddata-encoding-callback"><code>response.end()</code></a> executes, the value will be <code>true</code>.</p> 3822<h5><code>response.getHeader(name)</code><span><a class="mark" href="#responsegetheadername" id="responsegetheadername">#</a></span><a aria-hidden="true" class="legacy" id="http2_response_getheader_name"></a></h5> 3823<div class="api_metadata"> 3824<span>Added in: v8.4.0</span> 3825</div> 3826<ul> 3827<li><code>name</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3828<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3829</ul> 3830<p>Reads out a header that has already been queued but not sent to the client. 3831The name is case-insensitive.</p> 3832<pre><code class="language-js"><span class="hljs-keyword">const</span> contentType = response.<span class="hljs-title function_">getHeader</span>(<span class="hljs-string">'content-type'</span>);</code> <button class="copy-button">copy</button></pre> 3833<h5><code>response.getHeaderNames()</code><span><a class="mark" href="#responsegetheadernames" id="responsegetheadernames">#</a></span><a aria-hidden="true" class="legacy" id="http2_response_getheadernames"></a></h5> 3834<div class="api_metadata"> 3835<span>Added in: v8.4.0</span> 3836</div> 3837<ul> 3838<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string[]></a></li> 3839</ul> 3840<p>Returns an array containing the unique names of the current outgoing headers. 3841All header names are lowercase.</p> 3842<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>); 3843response.<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>]); 3844 3845<span class="hljs-keyword">const</span> headerNames = response.<span class="hljs-title function_">getHeaderNames</span>(); 3846<span class="hljs-comment">// headerNames === ['foo', 'set-cookie']</span></code> <button class="copy-button">copy</button></pre> 3847<h5><code>response.getHeaders()</code><span><a class="mark" href="#responsegetheaders" id="responsegetheaders">#</a></span><a aria-hidden="true" class="legacy" id="http2_response_getheaders"></a></h5> 3848<div class="api_metadata"> 3849<span>Added in: v8.4.0</span> 3850</div> 3851<ul> 3852<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 3853</ul> 3854<p>Returns a shallow copy of the current outgoing headers. Since a shallow copy 3855is used, array values may be mutated without additional calls to various 3856header-related http module methods. The keys of the returned object are the 3857header names and the values are the respective header values. All header names 3858are lowercase.</p> 3859<p>The object returned by the <code>response.getHeaders()</code> method <em>does not</em> 3860prototypically inherit from the JavaScript <code>Object</code>. This means that typical 3861<code>Object</code> methods such as <code>obj.toString()</code>, <code>obj.hasOwnProperty()</code>, and others 3862are not defined and <em>will not work</em>.</p> 3863<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>); 3864response.<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>]); 3865 3866<span class="hljs-keyword">const</span> headers = response.<span class="hljs-title function_">getHeaders</span>(); 3867<span class="hljs-comment">// headers === { foo: 'bar', 'set-cookie': ['foo=bar', 'bar=baz'] }</span></code> <button class="copy-button">copy</button></pre> 3868<h5><code>response.hasHeader(name)</code><span><a class="mark" href="#responsehasheadername" id="responsehasheadername">#</a></span><a aria-hidden="true" class="legacy" id="http2_response_hasheader_name"></a></h5> 3869<div class="api_metadata"> 3870<span>Added in: v8.4.0</span> 3871</div> 3872<ul> 3873<li><code>name</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3874<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 3875</ul> 3876<p>Returns <code>true</code> if the header identified by <code>name</code> is currently set in the 3877outgoing headers. The header name matching is case-insensitive.</p> 3878<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> <button class="copy-button">copy</button></pre> 3879<h5><code>response.headersSent</code><span><a class="mark" href="#responseheaderssent" id="responseheaderssent">#</a></span><a aria-hidden="true" class="legacy" id="http2_response_headerssent"></a></h5> 3880<div class="api_metadata"> 3881<span>Added in: v8.4.0</span> 3882</div> 3883<ul> 3884<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 3885</ul> 3886<p>True if headers were sent, false otherwise (read-only).</p> 3887<h5><code>response.removeHeader(name)</code><span><a class="mark" href="#responseremoveheadername" id="responseremoveheadername">#</a></span><a aria-hidden="true" class="legacy" id="http2_response_removeheader_name"></a></h5> 3888<div class="api_metadata"> 3889<span>Added in: v8.4.0</span> 3890</div> 3891<ul> 3892<li><code>name</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3893</ul> 3894<p>Removes a header that has been queued for implicit sending.</p> 3895<pre><code class="language-js">response.<span class="hljs-title function_">removeHeader</span>(<span class="hljs-string">'Content-Encoding'</span>);</code> <button class="copy-button">copy</button></pre> 3896<h5><code>response.req</code><span><a class="mark" href="#responsereq" id="responsereq">#</a></span><a aria-hidden="true" class="legacy" id="http2_response_req"></a></h5> 3897<div class="api_metadata"> 3898<span>Added in: v15.7.0</span> 3899</div> 3900<ul> 3901<li><a href="http2.html#class-http2http2serverrequest" class="type"><http2.Http2ServerRequest></a></li> 3902</ul> 3903<p>A reference to the original HTTP2 <code>request</code> object.</p> 3904<h5><code>response.sendDate</code><span><a class="mark" href="#responsesenddate" id="responsesenddate">#</a></span><a aria-hidden="true" class="legacy" id="http2_response_senddate"></a></h5> 3905<div class="api_metadata"> 3906<span>Added in: v8.4.0</span> 3907</div> 3908<ul> 3909<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 3910</ul> 3911<p>When true, the Date header will be automatically generated and sent in 3912the response if it is not already present in the headers. Defaults to true.</p> 3913<p>This should only be disabled for testing; HTTP requires the Date header 3914in responses.</p> 3915<h5><code>response.setHeader(name, value)</code><span><a class="mark" href="#responsesetheadername-value" id="responsesetheadername-value">#</a></span><a aria-hidden="true" class="legacy" id="http2_response_setheader_name_value"></a></h5> 3916<div class="api_metadata"> 3917<span>Added in: v8.4.0</span> 3918</div> 3919<ul> 3920<li><code>name</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3921<li><code>value</code> <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#String_type" class="type"><string[]></a></li> 3922</ul> 3923<p>Sets a single header value for implicit headers. If this header already exists 3924in the to-be-sent headers, its value will be replaced. Use an array of strings 3925here to send multiple headers with the same name.</p> 3926<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; charset=utf-8'</span>);</code> <button class="copy-button">copy</button></pre> 3927<p>or</p> 3928<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> <button class="copy-button">copy</button></pre> 3929<p>Attempting to set a header field name or value that contains invalid characters 3930will result in a <a href="errors.html#class-typeerror"><code>TypeError</code></a> being thrown.</p> 3931<p>When headers have been set with <a href="#responsesetheadername-value"><code>response.setHeader()</code></a>, they will be merged 3932with any headers passed to <a href="#responsewriteheadstatuscode-statusmessage-headers"><code>response.writeHead()</code></a>, with the headers passed 3933to <a href="#responsewriteheadstatuscode-statusmessage-headers"><code>response.writeHead()</code></a> given precedence.</p> 3934<pre><code class="language-js"><span class="hljs-comment">// Returns content-type = text/plain</span> 3935<span class="hljs-keyword">const</span> server = http2.<span class="hljs-title function_">createServer</span>(<span class="hljs-function">(<span class="hljs-params">req, res</span>) =></span> { 3936 res.<span class="hljs-title function_">setHeader</span>(<span class="hljs-string">'Content-Type'</span>, <span class="hljs-string">'text/html; charset=utf-8'</span>); 3937 res.<span class="hljs-title function_">setHeader</span>(<span class="hljs-string">'X-Foo'</span>, <span class="hljs-string">'bar'</span>); 3938 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; charset=utf-8'</span> }); 3939 res.<span class="hljs-title function_">end</span>(<span class="hljs-string">'ok'</span>); 3940});</code> <button class="copy-button">copy</button></pre> 3941<h5><code>response.setTimeout(msecs[, callback])</code><span><a class="mark" href="#responsesettimeoutmsecs-callback" id="responsesettimeoutmsecs-callback">#</a></span><a aria-hidden="true" class="legacy" id="http2_response_settimeout_msecs_callback"></a></h5> 3942<div class="api_metadata"> 3943<span>Added in: v8.4.0</span> 3944</div> 3945<ul> 3946<li><code>msecs</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 3947<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 3948<li>Returns: <a href="http2.html#class-http2http2serverresponse" class="type"><http2.Http2ServerResponse></a></li> 3949</ul> 3950<p>Sets the <a href="#class-http2stream"><code>Http2Stream</code></a>'s timeout value to <code>msecs</code>. If a callback is 3951provided, then it is added as a listener on the <code>'timeout'</code> event on 3952the response object.</p> 3953<p>If no <code>'timeout'</code> listener is added to the request, the response, or 3954the server, then <a href="#class-http2stream"><code>Http2Stream</code></a>s are destroyed when they time out. If a 3955handler is assigned to the request, the response, or the server's <code>'timeout'</code> 3956events, timed out sockets must be handled explicitly.</p> 3957<h5><code>response.socket</code><span><a class="mark" href="#responsesocket" id="responsesocket">#</a></span><a aria-hidden="true" class="legacy" id="http2_response_socket"></a></h5> 3958<div class="api_metadata"> 3959<span>Added in: v8.4.0</span> 3960</div> 3961<ul> 3962<li><a href="net.html#class-netsocket" class="type"><net.Socket></a> | <a href="tls.html#class-tlstlssocket" class="type"><tls.TLSSocket></a></li> 3963</ul> 3964<p>Returns a <code>Proxy</code> object that acts as a <code>net.Socket</code> (or <code>tls.TLSSocket</code>) but 3965applies getters, setters, and methods based on HTTP/2 logic.</p> 3966<p><code>destroyed</code>, <code>readable</code>, and <code>writable</code> properties will be retrieved from and 3967set on <code>response.stream</code>.</p> 3968<p><code>destroy</code>, <code>emit</code>, <code>end</code>, <code>on</code> and <code>once</code> methods will be called on 3969<code>response.stream</code>.</p> 3970<p><code>setTimeout</code> method will be called on <code>response.stream.session</code>.</p> 3971<p><code>pause</code>, <code>read</code>, <code>resume</code>, and <code>write</code> will throw an error with code 3972<code>ERR_HTTP2_NO_SOCKET_MANIPULATION</code>. See <a href="#http2session-and-sockets"><code>Http2Session</code> and Sockets</a> for 3973more information.</p> 3974<p>All other interactions will be routed directly to the socket.</p> 3975<pre><code class="language-js"><span class="hljs-keyword">const</span> http2 = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http2'</span>); 3976<span class="hljs-keyword">const</span> server = http2.<span class="hljs-title function_">createServer</span>(<span class="hljs-function">(<span class="hljs-params">req, res</span>) =></span> { 3977 <span class="hljs-keyword">const</span> ip = req.<span class="hljs-property">socket</span>.<span class="hljs-property">remoteAddress</span>; 3978 <span class="hljs-keyword">const</span> port = req.<span class="hljs-property">socket</span>.<span class="hljs-property">remotePort</span>; 3979 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>); 3980}).<span class="hljs-title function_">listen</span>(<span class="hljs-number">3000</span>);</code> <button class="copy-button">copy</button></pre> 3981<h5><code>response.statusCode</code><span><a class="mark" href="#responsestatuscode" id="responsestatuscode">#</a></span><a aria-hidden="true" class="legacy" id="http2_response_statuscode"></a></h5> 3982<div class="api_metadata"> 3983<span>Added in: v8.4.0</span> 3984</div> 3985<ul> 3986<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 3987</ul> 3988<p>When using implicit headers (not calling <a href="#responsewriteheadstatuscode-statusmessage-headers"><code>response.writeHead()</code></a> explicitly), 3989this property controls the status code that will be sent to the client when 3990the headers get flushed.</p> 3991<pre><code class="language-js">response.<span class="hljs-property">statusCode</span> = <span class="hljs-number">404</span>;</code> <button class="copy-button">copy</button></pre> 3992<p>After response header was sent to the client, this property indicates the 3993status code which was sent out.</p> 3994<h5><code>response.statusMessage</code><span><a class="mark" href="#responsestatusmessage" id="responsestatusmessage">#</a></span><a aria-hidden="true" class="legacy" id="http2_response_statusmessage"></a></h5> 3995<div class="api_metadata"> 3996<span>Added in: v8.4.0</span> 3997</div> 3998<ul> 3999<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 4000</ul> 4001<p>Status message is not supported by HTTP/2 (RFC 7540 8.1.2.4). It returns 4002an empty string.</p> 4003<h5><code>response.stream</code><span><a class="mark" href="#responsestream" id="responsestream">#</a></span><a aria-hidden="true" class="legacy" id="http2_response_stream"></a></h5> 4004<div class="api_metadata"> 4005<span>Added in: v8.4.0</span> 4006</div> 4007<ul> 4008<li><a href="http2.html#class-http2stream" class="type"><Http2Stream></a></li> 4009</ul> 4010<p>The <a href="#class-http2stream"><code>Http2Stream</code></a> object backing the response.</p> 4011<h5><code>response.writableEnded</code><span><a class="mark" href="#responsewritableended" id="responsewritableended">#</a></span><a aria-hidden="true" class="legacy" id="http2_response_writableended"></a></h5> 4012<div class="api_metadata"> 4013<span>Added in: v12.9.0</span> 4014</div> 4015<ul> 4016<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 4017</ul> 4018<p>Is <code>true</code> after <a href="#responseenddata-encoding-callback"><code>response.end()</code></a> has been called. This property 4019does not indicate whether the data has been flushed, for this use 4020<a href="stream.html#writablewritablefinished"><code>writable.writableFinished</code></a> instead.</p> 4021<h5><code>response.write(chunk[, encoding][, callback])</code><span><a class="mark" href="#responsewritechunk-encoding-callback" id="responsewritechunk-encoding-callback">#</a></span><a aria-hidden="true" class="legacy" id="http2_response_write_chunk_encoding_callback"></a></h5> 4022<div class="api_metadata"> 4023<span>Added in: v8.4.0</span> 4024</div> 4025<ul> 4026<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#class-buffer" class="type"><Buffer></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array" class="type"><Uint8Array></a></li> 4027<li><code>encoding</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 4028<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 4029<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 4030</ul> 4031<p>If this method is called and <a href="#responsewriteheadstatuscode-statusmessage-headers"><code>response.writeHead()</code></a> has not been called, 4032it will switch to implicit header mode and flush the implicit headers.</p> 4033<p>This sends a chunk of the response body. This method may 4034be called multiple times to provide successive parts of the body.</p> 4035<p>In the <code>node:http</code> module, the response body is omitted when the 4036request is a HEAD request. Similarly, the <code>204</code> and <code>304</code> responses 4037<em>must not</em> include a message body.</p> 4038<p><code>chunk</code> can be a string or a buffer. If <code>chunk</code> is a string, 4039the second parameter specifies how to encode it into a byte stream. 4040By default the <code>encoding</code> is <code>'utf8'</code>. <code>callback</code> will be called when this chunk 4041of data is flushed.</p> 4042<p>This is the raw HTTP body and has nothing to do with higher-level multi-part 4043body encodings that may be used.</p> 4044<p>The first time <a href="#responsewritechunk-encoding-callback"><code>response.write()</code></a> is called, it will send the buffered 4045header information and the first chunk of the body to the client. The second 4046time <a href="#responsewritechunk-encoding-callback"><code>response.write()</code></a> is called, Node.js assumes data will be streamed, 4047and sends the new data separately. That is, the response is buffered up to the 4048first chunk of the body.</p> 4049<p>Returns <code>true</code> if the entire data was flushed successfully to the kernel 4050buffer. Returns <code>false</code> if all or part of the data was queued in user memory. 4051<code>'drain'</code> will be emitted when the buffer is free again.</p> 4052<h5><code>response.writeContinue()</code><span><a class="mark" href="#responsewritecontinue" id="responsewritecontinue">#</a></span><a aria-hidden="true" class="legacy" id="http2_response_writecontinue"></a></h5> 4053<div class="api_metadata"> 4054<span>Added in: v8.4.0</span> 4055</div> 4056<p>Sends a status <code>100 Continue</code> to the client, indicating that the request body 4057should be sent. See the <a href="#event-checkcontinue"><code>'checkContinue'</code></a> event on <code>Http2Server</code> and 4058<code>Http2SecureServer</code>.</p> 4059<h5><code>response.writeEarlyHints(hints)</code><span><a class="mark" href="#responsewriteearlyhintshints" id="responsewriteearlyhintshints">#</a></span><a aria-hidden="true" class="legacy" id="http2_response_writeearlyhints_hints"></a></h5> 4060<div class="api_metadata"> 4061<span>Added in: v18.11.0</span> 4062</div> 4063<ul> 4064<li><code>hints</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 4065</ul> 4066<p>Sends a status <code>103 Early Hints</code> to the client with a Link header, 4067indicating that the user agent can preload/preconnect the linked resources. 4068The <code>hints</code> is an object containing the values of headers to be sent with 4069early hints message.</p> 4070<p><strong>Example</strong></p> 4071<pre><code class="language-js"><span class="hljs-keyword">const</span> earlyHintsLink = <span class="hljs-string">'</styles.css>; rel=preload; as=style'</span>; 4072response.<span class="hljs-title function_">writeEarlyHints</span>({ 4073 <span class="hljs-string">'link'</span>: earlyHintsLink, 4074}); 4075 4076<span class="hljs-keyword">const</span> earlyHintsLinks = [ 4077 <span class="hljs-string">'</styles.css>; rel=preload; as=style'</span>, 4078 <span class="hljs-string">'</scripts.js>; rel=preload; as=script'</span>, 4079]; 4080response.<span class="hljs-title function_">writeEarlyHints</span>({ 4081 <span class="hljs-string">'link'</span>: earlyHintsLinks, 4082});</code> <button class="copy-button">copy</button></pre> 4083<h5><code>response.writeHead(statusCode[, statusMessage][, headers])</code><span><a class="mark" href="#responsewriteheadstatuscode-statusmessage-headers" id="responsewriteheadstatuscode-statusmessage-headers">#</a></span><a aria-hidden="true" class="legacy" id="http2_response_writehead_statuscode_statusmessage_headers"></a></h5> 4084<div class="api_metadata"> 4085<details class="changelog"><summary>History</summary> 4086<table> 4087<tbody><tr><th>Version</th><th>Changes</th></tr> 4088<tr><td>v11.10.0, v10.17.0</td> 4089<td><p>Return <code>this</code> from <code>writeHead()</code> to allow chaining with <code>end()</code>.</p></td></tr> 4090<tr><td>v8.4.0</td> 4091<td><p><span>Added in: v8.4.0</span></p></td></tr> 4092</tbody></table> 4093</details> 4094</div> 4095<ul> 4096<li><code>statusCode</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 4097<li><code>statusMessage</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 4098<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> 4099<li>Returns: <a href="http2.html#class-http2http2serverresponse" class="type"><http2.Http2ServerResponse></a></li> 4100</ul> 4101<p>Sends a response header to the request. The status code is a 3-digit HTTP 4102status code, like <code>404</code>. The last argument, <code>headers</code>, are the response headers.</p> 4103<p>Returns a reference to the <code>Http2ServerResponse</code>, so that calls can be chained.</p> 4104<p>For compatibility with <a href="http.html">HTTP/1</a>, a human-readable <code>statusMessage</code> may be 4105passed as the second argument. However, because the <code>statusMessage</code> has no 4106meaning within HTTP/2, the argument will have no effect and a process warning 4107will be emitted.</p> 4108<pre><code class="language-js"><span class="hljs-keyword">const</span> body = <span class="hljs-string">'hello world'</span>; 4109response.<span class="hljs-title function_">writeHead</span>(<span class="hljs-number">200</span>, { 4110 <span class="hljs-string">'Content-Length'</span>: <span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">byteLength</span>(body), 4111 <span class="hljs-string">'Content-Type'</span>: <span class="hljs-string">'text/plain; charset=utf-8'</span>, 4112});</code> <button class="copy-button">copy</button></pre> 4113<p><code>Content-Length</code> is given in bytes not characters. The 4114<code>Buffer.byteLength()</code> API may be used to determine the number of bytes in a 4115given encoding. On outbound messages, Node.js does not check if Content-Length 4116and the length of the body being transmitted are equal or not. However, when 4117receiving messages, Node.js will automatically reject messages when the 4118<code>Content-Length</code> does not match the actual payload size.</p> 4119<p>This method may be called at most one time on a message before 4120<a href="#responseenddata-encoding-callback"><code>response.end()</code></a> is called.</p> 4121<p>If <a href="#responsewritechunk-encoding-callback"><code>response.write()</code></a> or <a href="#responseenddata-encoding-callback"><code>response.end()</code></a> are called before calling 4122this, the implicit/mutable headers will be calculated and call this function.</p> 4123<p>When headers have been set with <a href="#responsesetheadername-value"><code>response.setHeader()</code></a>, they will be merged 4124with any headers passed to <a href="#responsewriteheadstatuscode-statusmessage-headers"><code>response.writeHead()</code></a>, with the headers passed 4125to <a href="#responsewriteheadstatuscode-statusmessage-headers"><code>response.writeHead()</code></a> given precedence.</p> 4126<pre><code class="language-js"><span class="hljs-comment">// Returns content-type = text/plain</span> 4127<span class="hljs-keyword">const</span> server = http2.<span class="hljs-title function_">createServer</span>(<span class="hljs-function">(<span class="hljs-params">req, res</span>) =></span> { 4128 res.<span class="hljs-title function_">setHeader</span>(<span class="hljs-string">'Content-Type'</span>, <span class="hljs-string">'text/html; charset=utf-8'</span>); 4129 res.<span class="hljs-title function_">setHeader</span>(<span class="hljs-string">'X-Foo'</span>, <span class="hljs-string">'bar'</span>); 4130 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; charset=utf-8'</span> }); 4131 res.<span class="hljs-title function_">end</span>(<span class="hljs-string">'ok'</span>); 4132});</code> <button class="copy-button">copy</button></pre> 4133<p>Attempting to set a header field name or value that contains invalid characters 4134will result in a <a href="errors.html#class-typeerror"><code>TypeError</code></a> being thrown.</p> 4135</section><section><h3>Collecting HTTP/2 performance metrics<span><a class="mark" href="#collecting-http2-performance-metrics" id="collecting-http2-performance-metrics">#</a></span><a aria-hidden="true" class="legacy" id="http2_collecting_http_2_performance_metrics"></a></h3> 4136<p>The <a href="perf_hooks.html">Performance Observer</a> API can be used to collect basic performance 4137metrics for each <code>Http2Session</code> and <code>Http2Stream</code> instance.</p> 4138<pre><code class="language-js"><span class="hljs-keyword">const</span> { <span class="hljs-title class_">PerformanceObserver</span> } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:perf_hooks'</span>); 4139 4140<span class="hljs-keyword">const</span> obs = <span class="hljs-keyword">new</span> <span class="hljs-title class_">PerformanceObserver</span>(<span class="hljs-function">(<span class="hljs-params">items</span>) =></span> { 4141 <span class="hljs-keyword">const</span> entry = items.<span class="hljs-title function_">getEntries</span>()[<span class="hljs-number">0</span>]; 4142 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(entry.<span class="hljs-property">entryType</span>); <span class="hljs-comment">// prints 'http2'</span> 4143 <span class="hljs-keyword">if</span> (entry.<span class="hljs-property">name</span> === <span class="hljs-string">'Http2Session'</span>) { 4144 <span class="hljs-comment">// Entry contains statistics about the Http2Session</span> 4145 } <span class="hljs-keyword">else</span> <span class="hljs-keyword">if</span> (entry.<span class="hljs-property">name</span> === <span class="hljs-string">'Http2Stream'</span>) { 4146 <span class="hljs-comment">// Entry contains statistics about the Http2Stream</span> 4147 } 4148}); 4149obs.<span class="hljs-title function_">observe</span>({ <span class="hljs-attr">entryTypes</span>: [<span class="hljs-string">'http2'</span>] });</code> <button class="copy-button">copy</button></pre> 4150<p>The <code>entryType</code> property of the <code>PerformanceEntry</code> will be equal to <code>'http2'</code>.</p> 4151<p>The <code>name</code> property of the <code>PerformanceEntry</code> will be equal to either 4152<code>'Http2Stream'</code> or <code>'Http2Session'</code>.</p> 4153<p>If <code>name</code> is equal to <code>Http2Stream</code>, the <code>PerformanceEntry</code> will contain the 4154following additional properties:</p> 4155<ul> 4156<li><code>bytesRead</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The number of <code>DATA</code> frame bytes received for this 4157<code>Http2Stream</code>.</li> 4158<li><code>bytesWritten</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The number of <code>DATA</code> frame bytes sent for this 4159<code>Http2Stream</code>.</li> 4160<li><code>id</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The identifier of the associated <code>Http2Stream</code></li> 4161<li><code>timeToFirstByte</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The number of milliseconds elapsed between the 4162<code>PerformanceEntry</code> <code>startTime</code> and the reception of the first <code>DATA</code> frame.</li> 4163<li><code>timeToFirstByteSent</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The number of milliseconds elapsed between 4164the <code>PerformanceEntry</code> <code>startTime</code> and sending of the first <code>DATA</code> frame.</li> 4165<li><code>timeToFirstHeader</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The number of milliseconds elapsed between the 4166<code>PerformanceEntry</code> <code>startTime</code> and the reception of the first header.</li> 4167</ul> 4168<p>If <code>name</code> is equal to <code>Http2Session</code>, the <code>PerformanceEntry</code> will contain the 4169following additional properties:</p> 4170<ul> 4171<li><code>bytesRead</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The number of bytes received for this <code>Http2Session</code>.</li> 4172<li><code>bytesWritten</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The number of bytes sent for this <code>Http2Session</code>.</li> 4173<li><code>framesReceived</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The number of HTTP/2 frames received by the 4174<code>Http2Session</code>.</li> 4175<li><code>framesSent</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The number of HTTP/2 frames sent by the <code>Http2Session</code>.</li> 4176<li><code>maxConcurrentStreams</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The maximum number of streams concurrently 4177open during the lifetime of the <code>Http2Session</code>.</li> 4178<li><code>pingRTT</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The number of milliseconds elapsed since the transmission 4179of a <code>PING</code> frame and the reception of its acknowledgment. Only present if 4180a <code>PING</code> frame has been sent on the <code>Http2Session</code>.</li> 4181<li><code>streamAverageDuration</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The average duration (in milliseconds) for 4182all <code>Http2Stream</code> instances.</li> 4183<li><code>streamCount</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The number of <code>Http2Stream</code> instances processed by 4184the <code>Http2Session</code>.</li> 4185<li><code>type</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> Either <code>'server'</code> or <code>'client'</code> to identify the type of 4186<code>Http2Session</code>.</li> 4187</ul> 4188</section><section><h3>Note on <code>:authority</code> and <code>host</code><span><a class="mark" href="#note-on-authority-and-host" id="note-on-authority-and-host">#</a></span><a aria-hidden="true" class="legacy" id="http2_note_on_authority_and_host"></a></h3> 4189<p>HTTP/2 requires requests to have either the <code>:authority</code> pseudo-header 4190or the <code>host</code> header. Prefer <code>:authority</code> when constructing an HTTP/2 4191request directly, and <code>host</code> when converting from HTTP/1 (in proxies, 4192for instance).</p> 4193<p>The compatibility API falls back to <code>host</code> if <code>:authority</code> is not 4194present. See <a href="#requestauthority"><code>request.authority</code></a> for more information. However, 4195if you don't use the compatibility API (or use <code>req.headers</code> directly), 4196you need to implement any fall-back behavior yourself.</p></section> 4197 <!-- API END --> 4198 </div> 4199 </div> 4200 </div> 4201</body> 4202</html> 4203