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

doc,tools: fix make doc target for quic.md #221

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions doc/api/quic.md
Original file line number Diff line number Diff line change
Expand Up @@ -650,7 +650,7 @@ performed on this `QuicSession`.
added: REPLACEME
-->

* Type: {Number}
* Type: {number}

The total number of bytes the `QuicSession` is *currently* allowed to
send to the connected peer.
Expand Down Expand Up @@ -781,7 +781,7 @@ The `QuicSocket` the `QuicSession` is associated with.
added: REPLACEME
-->

* Type: {Boolean}
* Type: {boolean}

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

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

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

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

#### quicsocket.setDiagnosticPacketLoss(options)
<!-- YAML-
<!-- YAML
added: REPLACEME
-->

* `options` {Object}
* `rx` {double} A value in the range `0.0` to `1.0` that specifies the
* `rx` {number} A value in the range `0.0` to `1.0` that specifies the
probability of received packet loss.
* `tx` {double} A value in the range `0.0` to `1.0` that specifies the
* `tx` {number} A value in the range `0.0` to `1.0` that specifies the
probability of transmitted packet loss.

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

TBD

#### quicstream.submitInitialHeaders(headers)
<!-- YAML
added: REPLACEME
-->
* {headers} {Object}
* `headers` {Object}

TBD

#### quicstream.submitTrailingHeaders(headers)
<!-- YAML
added: REPLACEME
-->
* {headers} {Object}
* `headers` {Object}

TBD

Expand Down
4 changes: 2 additions & 2 deletions tools/doc/type-parser.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ const jsPrimitives = {

const jsGlobalObjectsUrl = `${jsDocPrefix}Reference/Global_Objects/`;
const jsGlobalTypes = [
'Array', 'ArrayBuffer', 'ArrayBufferView', 'DataView', 'Date', 'Error',
'EvalError', 'Function', 'Map', 'Object', 'Promise', 'RangeError',
'Array', 'ArrayBuffer', 'ArrayBufferView', 'BigInt', 'DataView', 'Date',
'Error', 'EvalError', 'Function', 'Map', 'Object', 'Promise', 'RangeError',
'ReferenceError', 'RegExp', 'Set', 'SharedArrayBuffer', 'SyntaxError',
'TypeError', 'TypedArray', 'URIError', 'Uint8Array',
];
Expand Down