Skip to content
This repository was archived by the owner on Aug 11, 2020. It is now read-only.

Commit a8ac638

Browse files
danbevaddaleax
authored andcommitted
doc,tools: fix make doc target for quic.md
Currently the doc target fails and this commit attempts for fix these errors. PR-URL: #221 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
1 parent fe26977 commit a8ac638

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

doc/api/quic.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -650,7 +650,7 @@ performed on this `QuicSession`.
650650
added: REPLACEME
651651
-->
652652

653-
* Type: {Number}
653+
* Type: {number}
654654

655655
The total number of bytes the `QuicSession` is *currently* allowed to
656656
send to the connected peer.
@@ -781,7 +781,7 @@ The `QuicSocket` the `QuicSession` is associated with.
781781
added: REPLACEME
782782
-->
783783

784-
* Type: {Boolean}
784+
* Type: {boolean}
785785

786786
True if the `QuicSession` was closed due to QUIC stateless reset.
787787

@@ -939,7 +939,7 @@ The callback *must* be invoked in order for the TLS handshake to continue.
939939
added: REPLACEME
940940
-->
941941

942-
* `servername` {String} A DNS name to associate with the given context.
942+
* `servername` {string} A DNS name to associate with the given context.
943943
* `context` {tls.SecureContext} A TLS SecureContext to associate with the `servername`.
944944

945945
TBD
@@ -1441,14 +1441,14 @@ A `BitInt` representing the number of server `QuicSession` instances that
14411441
have been associated with this `QuicSocket`.
14421442

14431443
#### quicsocket.setDiagnosticPacketLoss(options)
1444-
<!-- YAML-
1444+
<!-- YAML
14451445
added: REPLACEME
14461446
-->
14471447

14481448
* `options` {Object}
1449-
* `rx` {double} A value in the range `0.0` to `1.0` that specifies the
1449+
* `rx` {number} A value in the range `0.0` to `1.0` that specifies the
14501450
probability of received packet loss.
1451-
* `tx` {double} A value in the range `0.0` to `1.0` that specifies the
1451+
* `tx` {number} A value in the range `0.0` to `1.0` that specifies the
14521452
probability of transmitted packet loss.
14531453

14541454
The `quicsocket.setDiagnosticPacketLoss()` method is a diagnostic only tool
@@ -1917,23 +1917,23 @@ bytes that are read from the file.
19171917
<!-- YAML
19181918
added: REPLACEME
19191919
-->
1920-
* {headers} {Object}
1920+
* `headers` {Object}
19211921

19221922
TBD
19231923

19241924
#### quicstream.submitInitialHeaders(headers)
19251925
<!-- YAML
19261926
added: REPLACEME
19271927
-->
1928-
* {headers} {Object}
1928+
* `headers` {Object}
19291929

19301930
TBD
19311931

19321932
#### quicstream.submitTrailingHeaders(headers)
19331933
<!-- YAML
19341934
added: REPLACEME
19351935
-->
1936-
* {headers} {Object}
1936+
* `headers` {Object}
19371937

19381938
TBD
19391939

tools/doc/type-parser.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ const jsPrimitives = {
1515

1616
const jsGlobalObjectsUrl = `${jsDocPrefix}Reference/Global_Objects/`;
1717
const jsGlobalTypes = [
18-
'Array', 'ArrayBuffer', 'ArrayBufferView', 'DataView', 'Date', 'Error',
19-
'EvalError', 'Function', 'Map', 'Object', 'Promise', 'RangeError',
18+
'Array', 'ArrayBuffer', 'ArrayBufferView', 'BigInt', 'DataView', 'Date',
19+
'Error', 'EvalError', 'Function', 'Map', 'Object', 'Promise', 'RangeError',
2020
'ReferenceError', 'RegExp', 'Set', 'SharedArrayBuffer', 'SyntaxError',
2121
'TypeError', 'TypedArray', 'URIError', 'Uint8Array', 'WebAssembly.Instance',
2222
];

0 commit comments

Comments
 (0)