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

Commit 5baab3f

Browse files
danbevdanbev
committed
doc,quic: update BigInt type to lowercase
Currently the doc target fails with the following error: Error: Unrecognized type: 'BigInt'. Please, edit the type or update the 'tools/doc/type-parser.js'. at /quic/quic/tools/doc/type-parser.js:199:15 at Array.forEach (<anonymous>) at Object.toLink (/quic/tools/doc/type-parser.js:175:13) at /quic/quic/tools/doc/html.js:164:59 at Array.forEach (<anonymous>) at linkJsTypeDocs (/quic/quic/tools/doc/html.js:163:19) at /quic/tools/doc/html.js:111:23 This commit updates the types of BigInt to be lowercase which is how it is defined in type-parser.js. I would have thought using 'BigInt' would have been better but there might be a reason for this that I'm unware of ('bigint' is used in other files). With this commit the build passes and I'll look into why this type is lowercase and suggest fixing it in upstream/master. PR-URL: #385 Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent bc1b2c0 commit 5baab3f

File tree

1 file changed

+35
-35
lines changed

1 file changed

+35
-35
lines changed

‎doc/api/quic.md

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -677,7 +677,7 @@ The `'stream'` event may be emitted multiple times.
677677
added: REPLACEME
678678
-->
679679

680-
* Type: {BigInt}
680+
* Type: {bigint}
681681

682682
A `BigInt` representing the number of retransmissions caused by delayed
683683
acknowledgements.
@@ -726,7 +726,7 @@ representing the reason the peer certificate verification failed.
726726
added: REPLACEME
727727
-->
728728

729-
* Type: {BigInt}
729+
* Type: {bigint}
730730

731731
A `BigInt` representing the total number of bidirectional streams
732732
created for this `QuicSession`.
@@ -736,7 +736,7 @@ created for this `QuicSession`.
736736
added: REPLACEME
737737
-->
738738

739-
* Type: {BigInt}
739+
* Type: {bigint}
740740

741741
A `BigInt` representing the total number of times the `QuicSession` has
742742
been blocked from sending stream data due to flow control.
@@ -759,7 +759,7 @@ to the connected peer.
759759
added: REPLACEME
760760
-->
761761

762-
* Type: {BigInt}
762+
* Type: {bigint}
763763

764764
A `BigInt` representing the total number of bytes received from the peer.
765765

@@ -768,7 +768,7 @@ A `BigInt` representing the total number of bytes received from the peer.
768768
added: REPLACEME
769769
-->
770770

771-
* Type: {BigInt}
771+
* Type: {bigint}
772772

773773
A `BigInt` representing the total number of bytes sent to the peer.
774774

@@ -841,7 +841,7 @@ Set to `true` if the `QuicSession` has been destroyed.
841841
added: REPLACEME
842842
-->
843843

844-
* Type: {BigInt}
844+
* Type: {bigint}
845845

846846
A `BigInt` representing the length of time the `QuicSession` was active.
847847

@@ -912,7 +912,7 @@ Set to `true` when the TLS handshake completion has been confirmed.
912912
added: REPLACEME
913913
-->
914914

915-
* Type: {BigInt}
915+
* Type: {bigint}
916916

917917
A `BigInt` representing the length of time taken to complete the TLS handshake.
918918

@@ -930,7 +930,7 @@ Set to `true` if the `QuicSession` was closed due to an idle timeout.
930930
added: REPLACEME
931931
-->
932932

933-
* Type: {BigInt}
933+
* Type: {bigint}
934934

935935
A `BigInt` representing the number of key update operations that have
936936
occured.
@@ -940,7 +940,7 @@ occured.
940940
added: REPLACEME
941941
-->
942942

943-
* Type: {BigInt}
943+
* Type: {bigint}
944944

945945
The most recently recorded RTT for this `QuicSession`.
946946

@@ -949,7 +949,7 @@ The most recently recorded RTT for this `QuicSession`.
949949
added: REPLACEME
950950
-->
951951

952-
* Type: {BigInt}
952+
* Type: {bigint}
953953

954954
A `BigInt` representing the number of lost-packet retransmissions that have been
955955
performed on this `QuicSession`.
@@ -969,7 +969,7 @@ send to the connected peer.
969969
added: REPLACEME
970970
-->
971971

972-
* Type: {BigInt}
972+
* Type: {bigint}
973973

974974
A `BigInt` representing the maximum number of in-flight bytes recorded
975975
for this `QuicSession`.
@@ -993,7 +993,7 @@ of the `QuicSession` as the connected peer allows new streams to be created.
993993
added: REPLACEME
994994
-->
995995

996-
* Type: {BigInt}
996+
* Type: {bigint}
997997

998998
The minimum RTT recorded so far for this `QuicSession`.
999999

@@ -1035,7 +1035,7 @@ of the `ping()` operation.
10351035
added: REPLACEME
10361036
-->
10371037

1038-
* Type: {BigInt}
1038+
* Type: {bigint}
10391039

10401040
A `BigInt` representing the total number of `QuicStreams` initiated by the
10411041
connected peer.
@@ -1058,7 +1058,7 @@ An object containing the remote address information for the connected peer.
10581058
added: REPLACEME
10591059
-->
10601060

1061-
* Type: {BigInt}
1061+
* Type: {bigint}
10621062

10631063
A `BigInt` representing the total number of `QuicStream` instances initiated
10641064
by this `QuicSession`.
@@ -1077,7 +1077,7 @@ The SNI servername requested for this session by the client.
10771077
added: REPLACEME
10781078
-->
10791079

1080-
* Type: {BigInt}
1080+
* Type: {bigint}
10811081

10821082
The modified RTT calculated for this `QuicSession`.
10831083

@@ -1104,7 +1104,7 @@ True if the `QuicSession` was closed due to QUIC stateless reset.
11041104
added: REPLACEME
11051105
-->
11061106

1107-
* Type: {BigInt}
1107+
* Type: {bigint}
11081108

11091109
A `BigInt` representing the total number of unidirectional streams
11101110
created on this `QuicSession`.
@@ -1407,7 +1407,7 @@ port.
14071407
added: REPLACEME
14081408
-->
14091409

1410-
* Type: {BigInt}
1410+
* Type: {bigint}
14111411

14121412
A `BigInt` representing the length of time this `QuicSocket` has been bound
14131413
to a local port.
@@ -1417,7 +1417,7 @@ to a local port.
14171417
added: REPLACEME
14181418
-->
14191419

1420-
* Type: {BigInt}
1420+
* Type: {bigint}
14211421

14221422
A `BigInt` representing the number of bytes received by this `QuicSocket`.
14231423

@@ -1426,7 +1426,7 @@ A `BigInt` representing the number of bytes received by this `QuicSocket`.
14261426
added: REPLACEME
14271427
-->
14281428

1429-
* Type: {BigInt}
1429+
* Type: {bigint}
14301430

14311431
A `BigInt` representing the number of bytes sent by this `QuicSocket`.
14321432

@@ -1435,7 +1435,7 @@ A `BigInt` representing the number of bytes sent by this `QuicSocket`.
14351435
added: REPLACEME
14361436
-->
14371437

1438-
* Type: {BigInt}
1438+
* Type: {bigint}
14391439

14401440
A `BigInt` representing the number of client `QuicSession` instances that
14411441
have been associated with this `QuicSocket`.
@@ -1607,7 +1607,7 @@ Will be `true` if the `QuicSocket` has been destroyed.
16071607
added: REPLACEME
16081608
-->
16091609

1610-
* Type: {BigInt}
1610+
* Type: {bigint}
16111611

16121612
A `BigInt` representing the length of time this `QuicSocket` has been active,
16131613

@@ -1743,7 +1743,7 @@ If a `callback` is given, it is registered as a handler for the
17431743
added: REPLACEME
17441744
-->
17451745

1746-
* Type: {BigInt}
1746+
* Type: {bigint}
17471747

17481748
A `BigInt` representing the length of time this `QuicSocket` has been listening
17491749
for connections.
@@ -1762,7 +1762,7 @@ Set to `true` if the `QuicSocket` is listening for new connections.
17621762
added: REPLACEME
17631763
-->
17641764

1765-
* Type: {BigInt}
1765+
* Type: {bigint}
17661766

17671767
A `BigInt` representing the number of packets received by this `QuicSocket` that
17681768
have been ignored.
@@ -1772,7 +1772,7 @@ have been ignored.
17721772
added: REPLACEME
17731773
-->
17741774

1775-
* Type: {BigInt}
1775+
* Type: {bigint}
17761776

17771777
A `BigInt` representing the number of packets successfully received by this
17781778
`QuicSocket`.
@@ -1782,7 +1782,7 @@ A `BigInt` representing the number of packets successfully received by this
17821782
added: REPLACEME
17831783
-->
17841784

1785-
* Type: {BigInt}
1785+
* Type: {bigint}
17861786

17871787
A `BigInt` representing the number of packets sent by this `QuicSocket`.
17881788

@@ -1805,7 +1805,7 @@ added: REPLACEME
18051805
added: REPLACEME
18061806
-->
18071807

1808-
* Type: {BigInt}
1808+
* Type: {bigint}
18091809

18101810
A `BigInt` representing the number of `QuicSession` instances rejected
18111811
due to server busy status.
@@ -1815,7 +1815,7 @@ due to server busy status.
18151815
added: REPLACEME
18161816
-->
18171817

1818-
* Type: {BigInt}
1818+
* Type: {bigint}
18191819

18201820
A `BigInt` representing the number of server `QuicSession` instances that
18211821
have been associated with this `QuicSocket`.
@@ -1855,7 +1855,7 @@ error code. To begin receiving connections again, disable busy mode by calling
18551855
added: REPLACEME
18561856
-->
18571857

1858-
* Type: {BigInt}
1858+
* Type: {bigint}
18591859

18601860
A `BigInt` that represents the number of stateless resets that have been sent.
18611861

@@ -2016,7 +2016,7 @@ Set to `true` if the `QuicStream` is bidirectional.
20162016
added: REPLACEME
20172017
-->
20182018

2019-
* Type: {BigInt}
2019+
* Type: {bigint}
20202020

20212021
A `BigInt` representing the total number of bytes received for this
20222022
`QuicStream`.
@@ -2026,7 +2026,7 @@ A `BigInt` representing the total number of bytes received for this
20262026
added: REPLACEME
20272027
-->
20282028

2029-
* Type: {BigInt}
2029+
* Type: {bigint}
20302030

20312031
A `BigInt` representing the total number of bytes sent by this
20322032
`QuicStream`.
@@ -2075,7 +2075,7 @@ TBD
20752075
added: REPLACEME
20762076
-->
20772077

2078-
* Type: {BigInt}
2078+
* Type: {bigint}
20792079

20802080
A `BigInt` representing the length of time the `QuicStream` has been active.
20812081

@@ -2084,7 +2084,7 @@ A `BigInt` representing the length of time the `QuicStream` has been active.
20842084
added: REPLACEME
20852085
-->
20862086

2087-
* Type: {BigInt}
2087+
* Type: {bigint}
20882088

20892089
A `BigInt` specifying the total number of bytes successfully received by the
20902090
`QuicStream`.
@@ -2103,7 +2103,7 @@ The numeric identifier of the `QuicStream`.
21032103
added: REPLACEME
21042104
-->
21052105

2106-
* Type: {BigInt}
2106+
* Type: {bigint}
21072107

21082108
A `BigInt` representing the highest acknowledged data offset received
21092109
for this `QuicStream`.
@@ -2113,7 +2113,7 @@ for this `QuicStream`.
21132113
added: REPLACEME
21142114
-->
21152115

2116-
* Type: {BigInt}
2116+
* Type: {bigint}
21172117

21182118
A `BigInt` representing the maximum extended data offset that has been
21192119
reported to the connected peer.
@@ -2123,7 +2123,7 @@ reported to the connected peer.
21232123
added: REPLACEME
21242124
-->
21252125

2126-
* Type: {BigInt}
2126+
* Type: {bigint}
21272127

21282128
A `BigInt` representing the maximum received offset for this `QuicStream`.
21292129

0 commit comments

Comments
 (0)