@@ -229,8 +229,8 @@ 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 [ Headers Object] [ ] , and numeric flags associated with the creation
233
- of the stream.
232
+ object, a [ HTTP2 Headers Object] [ ] , and numeric flags associated with the
233
+ creation of the stream.
234
234
235
235
``` js
236
236
const http2 = require (' http2' );
@@ -382,7 +382,7 @@ Transmits a `GOAWAY` frame to the connected peer *without* shutting down the
382
382
added: v8.4.0
383
383
-->
384
384
385
- * Value: {[ Settings Object] [ ] }
385
+ * Value: {HTTP2 Settings Object}
386
386
387
387
A prototype-less object describing the current local settings of this
388
388
` Http2Session ` . The local settings are local to * this* ` Http2Session ` instance.
@@ -461,7 +461,7 @@ instance's underlying [`net.Socket`].
461
461
added: v8.4.0
462
462
-->
463
463
464
- * Value: {[ Settings Object] [ ] }
464
+ * Value: {HTTP2 Settings Object}
465
465
466
466
A prototype-less object describing the current remote settings of this
467
467
` Http2Session ` . The remote settings are set by the * connected* HTTP/2 peer.
@@ -570,8 +570,8 @@ An object describing the current status of this `Http2Session`.
570
570
added: v8.4.0
571
571
-->
572
572
573
- * ` settings ` {[ Settings Object] [ ] }
574
- * Returns: {undefined}
573
+ * ` settings ` {HTTP2 Settings Object}
574
+ * Returns {undefined}
575
575
576
576
Updates the current local settings for this ` Http2Session ` and sends a new
577
577
` SETTINGS ` frame to the connected HTTP/2 peer.
@@ -707,7 +707,7 @@ client.on('altsvc', (alt, origin, stream) => {
707
707
added: v8.4.0
708
708
-->
709
709
710
- * ` headers ` {[ Headers Object] [ ] }
710
+ * ` headers ` {HTTP2 Headers Object}
711
711
* ` options ` {Object}
712
712
* ` endStream ` {boolean} ` true ` if the ` Http2Stream ` * writable* side should
713
713
be closed initially, such as when sending a ` GET ` request that should not
@@ -895,7 +895,7 @@ added: v8.4.0
895
895
896
896
The ` 'trailers' ` event is emitted when a block of headers associated with
897
897
trailing header fields is received. The listener callback is passed the
898
- [ Headers Object] [ ] and flags associated with the headers.
898
+ [ HTTP2 Headers Object] [ ] and flags associated with the headers.
899
899
900
900
``` js
901
901
stream .on (' trailers' , (headers , flags ) => {
@@ -994,7 +994,7 @@ calling `http2stream.close()`, or `http2stream.destroy()`. Will be
994
994
added: REPLACEME
995
995
-->
996
996
997
- * Value: {[ Headers Object] [ ] }
997
+ * Value: {HTTP2 Headers Object}
998
998
999
999
An object containing the outbound headers sent for this ` Http2Stream ` .
1000
1000
@@ -1003,7 +1003,7 @@ An object containing the outbound headers sent for this `Http2Stream`.
1003
1003
added: REPLACEME
1004
1004
-->
1005
1005
1006
- * Value: {[ Headers Object] [ ] \[\ ] }
1006
+ * Value: {HTTP2 Headers Object[ ] }
1007
1007
1008
1008
An array of objects containing the outbound informational (additional) headers
1009
1009
sent for this ` Http2Stream ` .
@@ -1013,7 +1013,7 @@ sent for this `Http2Stream`.
1013
1013
added: REPLACEME
1014
1014
-->
1015
1015
1016
- * Value: {[ Headers Object] [ ] }
1016
+ * Value: {HTTP2 Headers Object}
1017
1017
1018
1018
An object containing the outbound trailers sent for this this ` HttpStream ` .
1019
1019
@@ -1096,8 +1096,8 @@ added: v8.4.0
1096
1096
1097
1097
The ` 'headers' ` event is emitted when an additional block of headers is received
1098
1098
for a stream, such as when a block of ` 1xx ` informational headers is received.
1099
- The listener callback is passed the [ Headers Object] [ ] and flags associated with
1100
- the headers.
1099
+ The listener callback is passed the [ HTTP2 Headers Object] [ ] and flags
1100
+ associated with the headers.
1101
1101
1102
1102
``` js
1103
1103
stream .on (' headers' , (headers , flags ) => {
@@ -1111,8 +1111,8 @@ added: v8.4.0
1111
1111
-->
1112
1112
1113
1113
The ` 'push' ` event is emitted when response headers for a Server Push stream
1114
- are received. The listener callback is passed the [ Headers Object] [ ] and flags
1115
- associated with the headers.
1114
+ are received. The listener callback is passed the [ HTTP2 Headers Object] [ ] and
1115
+ flags associated with the headers.
1116
1116
1117
1117
``` js
1118
1118
stream .on (' push' , (headers , flags ) => {
@@ -1128,7 +1128,7 @@ added: v8.4.0
1128
1128
The ` 'response' ` event is emitted when a response ` HEADERS ` frame has been
1129
1129
received for this stream from the connected HTTP/2 server. The listener is
1130
1130
invoked with two arguments: an Object containing the received
1131
- [ Headers Object] [ ] , and flags associated with the headers.
1131
+ [ HTTP2 Headers Object] [ ] , and flags associated with the headers.
1132
1132
1133
1133
For example:
1134
1134
@@ -1158,7 +1158,7 @@ provide additional methods such as `http2stream.pushStream()` and
1158
1158
added: v8.4.0
1159
1159
-->
1160
1160
1161
- * ` headers ` {[ Headers Object] [ ] }
1161
+ * ` headers ` {HTTP2 Headers Object}
1162
1162
* Returns: {undefined}
1163
1163
1164
1164
Sends an additional informational ` HEADERS ` frame to the connected HTTP/2 peer.
@@ -1189,7 +1189,7 @@ accepts push streams, `false` otherwise. Settings are the same for every
1189
1189
added: v8.4.0
1190
1190
-->
1191
1191
1192
- * ` headers ` {[ Headers Object] [ ] }
1192
+ * ` headers ` {HTTP2 Headers Object}
1193
1193
* ` options ` {Object}
1194
1194
* ` exclusive ` {boolean} When ` true ` and ` parent ` identifies a parent Stream,
1195
1195
the created stream is made the sole direct dependency of the parent, with
@@ -1200,9 +1200,9 @@ added: v8.4.0
1200
1200
* ` callback ` {Function} Callback that is called once the push stream has been
1201
1201
initiated.
1202
1202
* ` err ` {Error}
1203
- * ` pushStream ` {[ ` ServerHttp2Stream ` ] [ ] } The returned pushStream object.
1204
- * ` headers ` {[ Headers Object] [ ] } Headers object the pushStream was initiated
1205
- with.
1203
+ * ` pushStream ` {ServerHttp2Stream} The returned pushStream object.
1204
+ * ` headers ` {HTTP2 Headers Object} Headers object the pushStream was
1205
+ initiated with.
1206
1206
* Returns: {undefined}
1207
1207
1208
1208
Initiates a push stream. The callback is invoked with the new ` Http2Stream `
@@ -1232,7 +1232,7 @@ a `weight` value to `http2stream.priority` with the `silent` option set to
1232
1232
added: v8.4.0
1233
1233
-->
1234
1234
1235
- * ` headers ` {[ Headers Object] [ ] }
1235
+ * ` headers ` {HTTP2 Headers Object}
1236
1236
* ` options ` {Object}
1237
1237
* ` endStream ` {boolean} Set to ` true ` to indicate that the response will not
1238
1238
include payload data.
@@ -1278,7 +1278,7 @@ added: v8.4.0
1278
1278
-->
1279
1279
1280
1280
* ` fd ` {number} A readable file descriptor.
1281
- * ` headers ` {[ Headers Object] [ ] }
1281
+ * ` headers ` {HTTP2 Headers Object}
1282
1282
* ` options ` {Object}
1283
1283
* ` statCheck ` {Function}
1284
1284
* ` getTrailers ` {Function} Callback function invoked to collect trailer
@@ -1362,7 +1362,7 @@ added: v8.4.0
1362
1362
-->
1363
1363
1364
1364
* ` path ` {string|Buffer|URL}
1365
- * ` headers ` {[ Headers Object] [ ] }
1365
+ * ` headers ` {HTTP2 Headers Object}
1366
1366
* ` options ` {Object}
1367
1367
* ` statCheck ` {Function}
1368
1368
* ` onError ` {Function} Callback function invoked in the case of an
@@ -1728,7 +1728,7 @@ changes:
1728
1728
* ` selectPadding ` {Function} When ` options.paddingStrategy ` is equal to
1729
1729
` http2.constants.PADDING_STRATEGY_CALLBACK ` , provides the callback function
1730
1730
used to determine the padding. See [ Using options.selectPadding] [ ] .
1731
- * ` settings ` {[ Settings Object] [ ] } The initial settings to send to the
1731
+ * ` settings ` {HTTP2 Settings Object} The initial settings to send to the
1732
1732
remote peer upon connection.
1733
1733
* ` onRequestHandler ` {Function} See [ Compatibility API] [ ]
1734
1734
* Returns: {Http2Server}
@@ -1815,7 +1815,7 @@ changes:
1815
1815
* ` selectPadding ` {Function} When ` options.paddingStrategy ` is equal to
1816
1816
` http2.constants.PADDING_STRATEGY_CALLBACK ` , provides the callback function
1817
1817
used to determine the padding. See [ Using options.selectPadding] [ ] .
1818
- * ` settings ` {[ Settings Object] [ ] } The initial settings to send to the
1818
+ * ` settings ` {HTTP2 Settings Object} The initial settings to send to the
1819
1819
remote peer upon connection.
1820
1820
* ...: Any [ ` tls.createServer() ` ] [ ] options can be provided. For
1821
1821
servers, the identity options (` pfx ` or ` key ` /` cert ` ) are usually required.
@@ -1911,7 +1911,7 @@ changes:
1911
1911
* ` selectPadding ` {Function} When ` options.paddingStrategy ` is equal to
1912
1912
` http2.constants.PADDING_STRATEGY_CALLBACK ` , provides the callback function
1913
1913
used to determine the padding. See [ Using options.selectPadding] [ ] .
1914
- * ` settings ` {[ Settings Object] [ ] } The initial settings to send to the
1914
+ * ` settings ` {HTTP2 Settings Object} The initial settings to send to the
1915
1915
remote peer upon connection.
1916
1916
* ` createConnection ` {Function} An optional callback that receives the ` URL `
1917
1917
instance passed to ` connect ` and the ` options ` object, and returns any
@@ -1964,7 +1964,7 @@ a given number of milliseconds set using `http2server.setTimeout()`.
1964
1964
added: v8.4.0
1965
1965
-->
1966
1966
1967
- * Returns: {[ Settings Object] [ ] }
1967
+ * Returns: {HTTP2 Settings Object}
1968
1968
1969
1969
Returns an object containing the default settings for an ` Http2Session `
1970
1970
instance. This method returns a new object instance every time it is called
@@ -1975,7 +1975,7 @@ so instances returned may be safely modified for use.
1975
1975
added: v8.4.0
1976
1976
-->
1977
1977
1978
- * ` settings ` {[ Settings Object] [ ] }
1978
+ * ` settings ` {HTTP2 Settings Object}
1979
1979
* Returns: {Buffer}
1980
1980
1981
1981
Returns a ` Buffer ` instance containing serialized representation of the given
@@ -1997,10 +1997,10 @@ added: v8.4.0
1997
1997
-->
1998
1998
1999
1999
* ` buf ` {Buffer|Uint8Array} The packed settings.
2000
- * Returns: {[ Settings Object] [ ] }
2000
+ * Returns: {HTTP2 Settings Object}
2001
2001
2002
- Returns a [ Settings Object] [ ] containing the deserialized settings from the
2003
- given ` Buffer ` as generated by ` http2.getPackedSettings() ` .
2002
+ Returns a [ HTTP2 Settings Object] [ ] containing the deserialized settings from
2003
+ the given ` Buffer ` as generated by ` http2.getPackedSettings() ` .
2004
2004
2005
2005
### Headers Object
2006
2006
@@ -2372,7 +2372,7 @@ Example:
2372
2372
console .log (request .headers );
2373
2373
```
2374
2374
2375
- See [ Headers Object] [ ] .
2375
+ See [ HTTP2 Headers Object] [ ] .
2376
2376
2377
2377
* Note* : In HTTP/2, the request path, hostname, protocol, and method are
2378
2378
represented as special headers prefixed with the ` : ` character (e.g. ` ':path' ` ).
@@ -3094,13 +3094,13 @@ following additional properties:
3094
3094
[ Compatibility API ] : #http2_compatibility_api
3095
3095
[ HTTP/1 ] : http.html
3096
3096
[ HTTP/2 ] : https://tools.ietf.org/html/rfc7540
3097
+ [ HTTP2 Headers Object ] : #http2_headers_object
3098
+ [ HTTP2 Settings Object ] : #http2_settings_object
3097
3099
[ HTTPS ] : https.html
3098
- [ Headers Object ] : #http2_headers_object
3099
3100
[ Http2Session and Sockets ] : #http2_http2session_and_sockets
3100
3101
[ Performance Observer ] : perf_hooks.html
3101
3102
[ Readable Stream ] : stream.html#stream_class_stream_readable
3102
3103
[ RFC 7838 ] : https://tools.ietf.org/html/rfc7838
3103
- [ Settings Object ] : #http2_settings_object
3104
3104
[ Using options.selectPadding ] : #http2_using_options_selectpadding
3105
3105
[ Writable Stream ] : stream.html#stream_writable_streams
3106
3106
[ `'checkContinue'` ] : #http2_event_checkcontinue
0 commit comments