1
- # HTTP2
1
+ # HTTP/2
2
2
3
3
<!-- introduced_in=v8.4.0-->
4
4
@@ -229,7 +229,7 @@ added: v8.4.0
229
229
230
230
The ` 'stream' ` event is emitted when a new ` Http2Stream ` is created. When
231
231
invoked, the handler function will receive a reference to the ` Http2Stream `
232
- object, a [ HTTP2 Headers Object] [ ] , and numeric flags associated with the
232
+ object, a [ HTTP/2 Headers Object] [ ] , and numeric flags associated with the
233
233
creation of the stream.
234
234
235
235
``` js
@@ -381,7 +381,7 @@ Transmits a `GOAWAY` frame to the connected peer *without* shutting down the
381
381
added: v8.4.0
382
382
-->
383
383
384
- * Value: {HTTP2 Settings Object}
384
+ * Value: {HTTP/2 Settings Object}
385
385
386
386
A prototype-less object describing the current local settings of this
387
387
` Http2Session ` . The local settings are local to * this* ` Http2Session ` instance.
@@ -460,7 +460,7 @@ instance's underlying [`net.Socket`].
460
460
added: v8.4.0
461
461
-->
462
462
463
- * Value: {HTTP2 Settings Object}
463
+ * Value: {HTTP/2 Settings Object}
464
464
465
465
A prototype-less object describing the current remote settings of this
466
466
` Http2Session ` . The remote settings are set by the * connected* HTTP/2 peer.
@@ -530,7 +530,7 @@ An object describing the current status of this `Http2Session`.
530
530
added: v8.4.0
531
531
-->
532
532
533
- * ` settings ` {HTTP2 Settings Object}
533
+ * ` settings ` {HTTP/2 Settings Object}
534
534
535
535
Updates the current local settings for this ` Http2Session ` and sends a new
536
536
` SETTINGS ` frame to the connected HTTP/2 peer.
@@ -669,7 +669,7 @@ client.on('altsvc', (alt, origin, streamId) => {
669
669
added: v8.4.0
670
670
-->
671
671
672
- * ` headers ` {HTTP2 Headers Object}
672
+ * ` headers ` {HTTP/2 Headers Object}
673
673
* ` options ` {Object}
674
674
* ` endStream ` {boolean} ` true ` if the ` Http2Stream ` * writable* side should
675
675
be closed initially, such as when sending a ` GET ` request that should not
@@ -855,7 +855,7 @@ added: v8.4.0
855
855
856
856
The ` 'trailers' ` event is emitted when a block of headers associated with
857
857
trailing header fields is received. The listener callback is passed the
858
- [ HTTP2 Headers Object] [ ] and flags associated with the headers.
858
+ [ HTTP/2 Headers Object] [ ] and flags associated with the headers.
859
859
860
860
``` js
861
861
stream .on (' trailers' , (headers , flags ) => {
@@ -952,7 +952,7 @@ calling `http2stream.close()`, or `http2stream.destroy()`. Will be
952
952
added: v9.5.0
953
953
-->
954
954
955
- * Value: {HTTP2 Headers Object}
955
+ * Value: {HTTP/2 Headers Object}
956
956
957
957
An object containing the outbound headers sent for this ` Http2Stream ` .
958
958
@@ -961,7 +961,7 @@ An object containing the outbound headers sent for this `Http2Stream`.
961
961
added: v9.5.0
962
962
-->
963
963
964
- * Value: {HTTP2 Headers Object[ ] }
964
+ * Value: {HTTP/2 Headers Object[ ] }
965
965
966
966
An array of objects containing the outbound informational (additional) headers
967
967
sent for this ` Http2Stream ` .
@@ -971,7 +971,7 @@ sent for this `Http2Stream`.
971
971
added: v9.5.0
972
972
-->
973
973
974
- * Value: {HTTP2 Headers Object}
974
+ * Value: {HTTP/2 Headers Object}
975
975
976
976
An object containing the outbound trailers sent for this this ` HttpStream ` .
977
977
@@ -1053,7 +1053,7 @@ added: v8.4.0
1053
1053
1054
1054
The ` 'headers' ` event is emitted when an additional block of headers is received
1055
1055
for a stream, such as when a block of ` 1xx ` informational headers is received.
1056
- The listener callback is passed the [ HTTP2 Headers Object] [ ] and flags
1056
+ The listener callback is passed the [ HTTP/2 Headers Object] [ ] and flags
1057
1057
associated with the headers.
1058
1058
1059
1059
``` js
@@ -1068,7 +1068,7 @@ added: v8.4.0
1068
1068
-->
1069
1069
1070
1070
The ` 'push' ` event is emitted when response headers for a Server Push stream
1071
- are received. The listener callback is passed the [ HTTP2 Headers Object] [ ] and
1071
+ are received. The listener callback is passed the [ HTTP/2 Headers Object] [ ] and
1072
1072
flags associated with the headers.
1073
1073
1074
1074
``` js
@@ -1085,7 +1085,7 @@ added: v8.4.0
1085
1085
The ` 'response' ` event is emitted when a response ` HEADERS ` frame has been
1086
1086
received for this stream from the connected HTTP/2 server. The listener is
1087
1087
invoked with two arguments: an Object containing the received
1088
- [ HTTP2 Headers Object] [ ] , and flags associated with the headers.
1088
+ [ HTTP/2 Headers Object] [ ] , and flags associated with the headers.
1089
1089
1090
1090
``` js
1091
1091
const http2 = require (' http2' );
@@ -1113,7 +1113,7 @@ provide additional methods such as `http2stream.pushStream()` and
1113
1113
added: v8.4.0
1114
1114
-->
1115
1115
1116
- * ` headers ` {HTTP2 Headers Object}
1116
+ * ` headers ` {HTTP/2 Headers Object}
1117
1117
1118
1118
Sends an additional informational ` HEADERS ` frame to the connected HTTP/2 peer.
1119
1119
@@ -1143,7 +1143,7 @@ accepts push streams, `false` otherwise. Settings are the same for every
1143
1143
added: v8.4.0
1144
1144
-->
1145
1145
1146
- * ` headers ` {HTTP2 Headers Object}
1146
+ * ` headers ` {HTTP/2 Headers Object}
1147
1147
* ` options ` {Object}
1148
1148
* ` exclusive ` {boolean} When ` true ` and ` parent ` identifies a parent Stream,
1149
1149
the created stream is made the sole direct dependency of the parent, with
@@ -1155,7 +1155,7 @@ added: v8.4.0
1155
1155
initiated.
1156
1156
* ` err ` {Error}
1157
1157
* ` pushStream ` {ServerHttp2Stream} The returned pushStream object.
1158
- * ` headers ` {HTTP2 Headers Object} Headers object the pushStream was
1158
+ * ` headers ` {HTTP/2 Headers Object} Headers object the pushStream was
1159
1159
initiated with.
1160
1160
1161
1161
Initiates a push stream. The callback is invoked with the new ` Http2Stream `
@@ -1185,7 +1185,7 @@ a `weight` value to `http2stream.priority` with the `silent` option set to
1185
1185
added: v8.4.0
1186
1186
-->
1187
1187
1188
- * ` headers ` {HTTP2 Headers Object}
1188
+ * ` headers ` {HTTP/2 Headers Object}
1189
1189
* ` options ` {Object}
1190
1190
* ` endStream ` {boolean} Set to ` true ` to indicate that the response will not
1191
1191
include payload data.
@@ -1234,7 +1234,7 @@ changes:
1234
1234
-->
1235
1235
1236
1236
* ` fd ` {number} A readable file descriptor.
1237
- * ` headers ` {HTTP2 Headers Object}
1237
+ * ` headers ` {HTTP/2 Headers Object}
1238
1238
* ` options ` {Object}
1239
1239
* ` statCheck ` {Function}
1240
1240
* ` getTrailers ` {Function} Callback function invoked to collect trailer
@@ -1329,7 +1329,7 @@ changes:
1329
1329
-->
1330
1330
1331
1331
* ` path ` {string|Buffer|URL}
1332
- * ` headers ` {HTTP2 Headers Object}
1332
+ * ` headers ` {HTTP/2 Headers Object}
1333
1333
* ` options ` {Object}
1334
1334
* ` statCheck ` {Function}
1335
1335
* ` onError ` {Function} Callback function invoked in the case of an
@@ -1708,7 +1708,7 @@ changes:
1708
1708
* ` selectPadding ` {Function} When ` options.paddingStrategy ` is equal to
1709
1709
` http2.constants.PADDING_STRATEGY_CALLBACK ` , provides the callback function
1710
1710
used to determine the padding. See [ Using options.selectPadding] [ ] .
1711
- * ` settings ` {HTTP2 Settings Object} The initial settings to send to the
1711
+ * ` settings ` {HTTP/2 Settings Object} The initial settings to send to the
1712
1712
remote peer upon connection.
1713
1713
* ` Http1IncomingMessage ` {http.IncomingMessage} Specifies the IncomingMessage
1714
1714
class to used for HTTP/1 fallback. Useful for extending the original
@@ -1817,7 +1817,7 @@ changes:
1817
1817
* ` selectPadding ` {Function} When ` options.paddingStrategy ` is equal to
1818
1818
` http2.constants.PADDING_STRATEGY_CALLBACK ` , provides the callback function
1819
1819
used to determine the padding. See [ Using options.selectPadding] [ ] .
1820
- * ` settings ` {HTTP2 Settings Object} The initial settings to send to the
1820
+ * ` settings ` {HTTP/2 Settings Object} The initial settings to send to the
1821
1821
remote peer upon connection.
1822
1822
* ...: Any [ ` tls.createServer() ` ] [ ] options can be provided. For
1823
1823
servers, the identity options (` pfx ` or ` key ` /` cert ` ) are usually required.
@@ -1913,7 +1913,7 @@ changes:
1913
1913
* ` selectPadding ` {Function} When ` options.paddingStrategy ` is equal to
1914
1914
` http2.constants.PADDING_STRATEGY_CALLBACK ` , provides the callback function
1915
1915
used to determine the padding. See [ Using options.selectPadding] [ ] .
1916
- * ` settings ` {HTTP2 Settings Object} The initial settings to send to the
1916
+ * ` settings ` {HTTP/2 Settings Object} The initial settings to send to the
1917
1917
remote peer upon connection.
1918
1918
* ` createConnection ` {Function} An optional callback that receives the ` URL `
1919
1919
instance passed to ` connect ` and the ` options ` object, and returns any
@@ -1966,7 +1966,7 @@ a given number of milliseconds set using `http2server.setTimeout()`.
1966
1966
added: v8.4.0
1967
1967
-->
1968
1968
1969
- * Returns: {HTTP2 Settings Object}
1969
+ * Returns: {HTTP/2 Settings Object}
1970
1970
1971
1971
Returns an object containing the default settings for an ` Http2Session `
1972
1972
instance. This method returns a new object instance every time it is called
@@ -1977,7 +1977,7 @@ so instances returned may be safely modified for use.
1977
1977
added: v8.4.0
1978
1978
-->
1979
1979
1980
- * ` settings ` {HTTP2 Settings Object}
1980
+ * ` settings ` {HTTP/2 Settings Object}
1981
1981
* Returns: {Buffer}
1982
1982
1983
1983
Returns a ` Buffer ` instance containing serialized representation of the given
@@ -1999,9 +1999,9 @@ added: v8.4.0
1999
1999
-->
2000
2000
2001
2001
* ` buf ` {Buffer|Uint8Array} The packed settings.
2002
- * Returns: {HTTP2 Settings Object}
2002
+ * Returns: {HTTP/2 Settings Object}
2003
2003
2004
- Returns a [ HTTP2 Settings Object] [ ] containing the deserialized settings from
2004
+ Returns a [ HTTP/2 Settings Object] [ ] containing the deserialized settings from
2005
2005
the given ` Buffer ` as generated by ` http2.getPackedSettings() ` .
2006
2006
2007
2007
### Headers Object
@@ -2262,7 +2262,7 @@ In order to create a mixed [HTTPS][] and HTTP/2 server, refer to the
2262
2262
[ ALPN negotiation] [ ] section.
2263
2263
Upgrading from non-tls HTTP/1 servers is not supported.
2264
2264
2265
- The HTTP2 compatibility API is composed of [ ` Http2ServerRequest ` ] ( ) and
2265
+ The HTTP/2 compatibility API is composed of [ ` Http2ServerRequest ` ] ( ) and
2266
2266
[ ` Http2ServerResponse ` ] ( ) . They aim at API compatibility with HTTP/1, but
2267
2267
they do not hide the differences between the protocols. As an example,
2268
2268
the status message for HTTP codes is ignored.
@@ -2370,7 +2370,7 @@ Example:
2370
2370
console .log (request .headers );
2371
2371
```
2372
2372
2373
- See [ HTTP2 Headers Object] [ ] .
2373
+ See [ HTTP/2 Headers Object] [ ] .
2374
2374
2375
2375
In HTTP/2, the request path, hostname, protocol, and method are represented as
2376
2376
special headers prefixed with the ` : ` character (e.g. ` ':path' ` ). These special
@@ -3097,8 +3097,8 @@ following additional properties:
3097
3097
[ HTTP/1 ] : http.html
3098
3098
[ HTTP/2 ] : https://tools.ietf.org/html/rfc7540
3099
3099
[ HTTP/2 Unencrypted ] : https://http2.github.io/faq/#does-http2-require-encryption
3100
- [ HTTP2 Headers Object] : #http2_headers_object
3101
- [ HTTP2 Settings Object] : #http2_settings_object
3100
+ [ HTTP/2 Headers Object] : #http2_headers_object
3101
+ [ HTTP/2 Settings Object] : #http2_settings_object
3102
3102
[ HTTPS ] : https.html
3103
3103
[ Http2Session and Sockets ] : #http2_http2session_and_sockets
3104
3104
[ Performance Observer ] : perf_hooks.html
0 commit comments