@@ -288,7 +288,7 @@ session.on('timeout', () => { /** .. **/ });
288
288
added: v9.4.0
289
289
-->
290
290
291
- * Value: {string|undefined}
291
+ * {string|undefined}
292
292
293
293
Value will be ` undefined ` if the ` Http2Session ` is not yet connected to a
294
294
socket, ` h2c ` if the ` Http2Session ` is not connected to a ` TLSSocket ` , or
@@ -315,7 +315,7 @@ If specified, the `callback` function is registered as a handler for the
315
315
added: v9.4.0
316
316
-->
317
317
318
- * Value: {boolean}
318
+ * {boolean}
319
319
320
320
Will be ` true ` if this ` Http2Session ` instance has been closed, otherwise
321
321
` false ` .
@@ -346,7 +346,7 @@ If there are any remaining open `Http2Streams` associated with the
346
346
added: v8.4.0
347
347
-->
348
348
349
- * Value: {boolean}
349
+ * {boolean}
350
350
351
351
Will be ` true ` if this ` Http2Session ` instance has been destroyed and must no
352
352
longer be used, otherwise ` false ` .
@@ -356,7 +356,7 @@ longer be used, otherwise `false`.
356
356
added: v9.4.0
357
357
-->
358
358
359
- * Value: {boolean|undefined}
359
+ * {boolean|undefined}
360
360
361
361
Value is ` undefined ` if the ` Http2Session ` session socket has not yet been
362
362
connected, ` true ` if the ` Http2Session ` is connected with a ` TLSSocket ` ,
@@ -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: {HTTP/2 Settings Object}
384
+ * {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.
@@ -391,7 +391,7 @@ A prototype-less object describing the current local settings of this
391
391
added: v9.4.0
392
392
-->
393
393
394
- * Value: {string[ ] |undefined}
394
+ * {string[ ] |undefined}
395
395
396
396
If the ` Http2Session ` is connected to a ` TLSSocket ` , the ` originSet ` property
397
397
will return an Array of origins for which the ` Http2Session ` may be
@@ -402,7 +402,7 @@ considered authoritative.
402
402
added: v8.4.0
403
403
-->
404
404
405
- * Value: {boolean}
405
+ * {boolean}
406
406
407
407
Indicates whether or not the ` Http2Session ` is currently waiting for an
408
408
acknowledgment for a sent SETTINGS frame. Will be ` true ` after calling the
@@ -460,7 +460,7 @@ instance's underlying [`net.Socket`].
460
460
added: v8.4.0
461
461
-->
462
462
463
- * Value: {HTTP/2 Settings Object}
463
+ * {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.
@@ -482,7 +482,7 @@ registered as a listener on the `'timeout'` event.
482
482
added: v8.4.0
483
483
-->
484
484
485
- * Value: {net.Socket|tls.TLSSocket}
485
+ * {net.Socket|tls.TLSSocket}
486
486
487
487
Returns a Proxy object that acts as a ` net.Socket ` (or ` tls.TLSSocket ` ) but
488
488
limits available methods to ones safe to use with HTTP/2.
@@ -503,7 +503,7 @@ added: v8.4.0
503
503
Provides miscellaneous information about the current state of the
504
504
` Http2Session ` .
505
505
506
- * Value: {Object}
506
+ * {Object}
507
507
* ` effectiveLocalWindowSize ` {number} The current local (receive)
508
508
flow control window size for the ` Http2Session ` .
509
509
* ` effectiveRecvDataLength ` {number} The current number of bytes
@@ -548,7 +548,7 @@ multiple SETTINGS frames while acknowledgment is still pending.
548
548
added: v8.4.0
549
549
-->
550
550
551
- * Value: {number}
551
+ * {number}
552
552
553
553
The ` http2session.type ` will be equal to
554
554
` http2.constants.NGHTTP2_SESSION_SERVER ` if this ` Http2Session ` instance is a
@@ -868,7 +868,7 @@ stream.on('trailers', (headers, flags) => {
868
868
added: v8.4.0
869
869
-->
870
870
871
- * Value: {boolean}
871
+ * {boolean}
872
872
873
873
Set to ` true ` if the ` Http2Stream ` instance was aborted abnormally. When set,
874
874
the ` 'aborted' ` event will have been emitted.
@@ -878,8 +878,8 @@ the `'aborted'` event will have been emitted.
878
878
added: v8.4.0
879
879
-->
880
880
881
- * code {number} Unsigned 32-bit integer identifying the error code. ** Default: **
882
- ` http2.constants.NGHTTP2_NO_ERROR ` (` 0x00 ` ).
881
+ * ` code ` {number} Unsigned 32-bit integer identifying the error code.
882
+ ** Default: ** ` http2.constants.NGHTTP2_NO_ERROR ` (` 0x00 ` ).
883
883
* ` callback ` {Function} An optional function registered to listen for the
884
884
` 'close' ` event.
885
885
@@ -891,7 +891,7 @@ connected HTTP/2 peer.
891
891
added: v9.4.0
892
892
-->
893
893
894
- * Value: {boolean}
894
+ * {boolean}
895
895
896
896
Set to ` true ` if the ` Http2Stream ` instance has been closed.
897
897
@@ -900,7 +900,7 @@ Set to `true` if the `Http2Stream` instance has been closed.
900
900
added: v8.4.0
901
901
-->
902
902
903
- * Value: {boolean}
903
+ * {boolean}
904
904
905
905
Set to ` true ` if the ` Http2Stream ` instance has been destroyed and is no longer
906
906
usable.
@@ -910,7 +910,7 @@ usable.
910
910
added: v9.4.0
911
911
-->
912
912
913
- * Value: {boolean}
913
+ * {boolean}
914
914
915
915
Set to ` true ` if the ` Http2Stream ` instance has not yet been assigned a
916
916
numeric stream identifier.
@@ -940,7 +940,7 @@ Updates the priority for this `Http2Stream` instance.
940
940
added: v8.4.0
941
941
-->
942
942
943
- * Value: {number}
943
+ * {number}
944
944
945
945
Set to the ` RST_STREAM ` [ error code] [ ] reported when the ` Http2Stream ` is
946
946
destroyed after either receiving an ` RST_STREAM ` frame from the connected peer,
@@ -952,7 +952,7 @@ calling `http2stream.close()`, or `http2stream.destroy()`. Will be
952
952
added: v9.5.0
953
953
-->
954
954
955
- * Value: {HTTP/2 Headers Object}
955
+ * {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: {HTTP/2 Headers Object[ ] }
964
+ * {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: {HTTP/2 Headers Object}
974
+ * {HTTP/2 Headers Object}
975
975
976
976
An object containing the outbound trailers sent for this this ` HttpStream ` .
977
977
@@ -980,7 +980,7 @@ An object containing the outbound trailers sent for this this `HttpStream`.
980
980
added: v8.4.0
981
981
-->
982
982
983
- * Value: {Http2Session}
983
+ * {Http2Session}
984
984
985
985
A reference to the ` Http2Session ` instance that owns this ` Http2Stream ` . The
986
986
value will be ` undefined ` after the ` Http2Stream ` instance is destroyed.
@@ -1010,7 +1010,7 @@ added: v8.4.0
1010
1010
Provides miscellaneous information about the current state of the
1011
1011
` Http2Stream ` .
1012
1012
1013
- * Value: {Object}
1013
+ * {Object}
1014
1014
* ` localWindowSize ` {number} The number of bytes the connected peer may send
1015
1015
for this ` Http2Stream ` without receiving a ` WINDOW_UPDATE ` .
1016
1016
* ` state ` {number} A flag indicating the low-level current state of the
@@ -1122,7 +1122,7 @@ Sends an additional informational `HEADERS` frame to the connected HTTP/2 peer.
1122
1122
added: v8.4.0
1123
1123
-->
1124
1124
1125
- * Value: {boolean}
1125
+ * {boolean}
1126
1126
1127
1127
Boolean (read-only). True if headers were sent, false otherwise.
1128
1128
@@ -1131,7 +1131,7 @@ Boolean (read-only). True if headers were sent, false otherwise.
1131
1131
added: v8.4.0
1132
1132
-->
1133
1133
1134
- * Value: {boolean}
1134
+ * {boolean}
1135
1135
1136
1136
Read-only property mapped to the ` SETTINGS_ENABLE_PUSH ` flag of the remote
1137
1137
client's most recent ` SETTINGS ` frame. Will be ` true ` if the remote peer
0 commit comments