Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: fix headings in quic.md #34717

Closed
wants to merge 1 commit into from
Closed

doc: fix headings in quic.md #34717

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 14 additions & 14 deletions doc/api/quic.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ TBD

## QUIC JavaScript API

### `net.createQuicSocket(\[options\])`
### `net.createQuicSocket([options])`
<!-- YAML
added: REPLACEME
-->
Expand Down Expand Up @@ -336,7 +336,7 @@ The object will contain the properties:

If the `QuicEndpoint` is not bound, `quicendpoint.address` is an empty object.

#### `quicendpoint.bind(\[options\])`
#### `quicendpoint.bind([options])`
<!-- YAML
added: REPLACEME
-->
Expand Down Expand Up @@ -396,7 +396,7 @@ added: REPLACEME

Set to `true` if the `QuicEndpoint` is in the process of closing.

#### `quicendpoint.destroy(\[error\])`
#### `quicendpoint.destroy([error])`
<!-- YAML
added: REPLACEME
-->
Expand Down Expand Up @@ -455,7 +455,7 @@ the local UDP port.
added: REPLACEME
-->

#### `quicendpoint.setBroadcast(\[on\])`
#### `quicendpoint.setBroadcast([on])`
<!-- YAML
added: REPLACEME
-->
Expand Down Expand Up @@ -552,7 +552,7 @@ A socket's address family's ANY address (IPv4 `'0.0.0.0'` or IPv6 `'::'`)
can be used to return control of the sockets default outgoing interface to
the system for future multicast packets.

#### `quicendpoint.setMulticastLoopback(\[on\])`
#### `quicendpoint.setMulticastLoopback([on])`
<!-- YAML
added: REPLACEME
-->
Expand Down Expand Up @@ -844,7 +844,7 @@ added: REPLACEME

Set to `true` if the `QuicSession` is in the process of a graceful shutdown.

#### `quicsession.destroy(\[error\])`
#### `quicsession.destroy([error])`
<!-- YAML
added: REPLACEME
-->
Expand Down Expand Up @@ -888,7 +888,7 @@ some properties corresponding to the fields of the certificate.
If there is no local certificate, or if the `QuicSession` has been destroyed,
an empty object will be returned.

#### `quicsession.getPeerCertificate(\[detailed\])`
#### `quicsession.getPeerCertificate([detailed])`
<!-- YAML
added: REPLACEME
-->
Expand Down Expand Up @@ -1025,7 +1025,7 @@ added: REPLACEME

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

#### `quicsession.openStream(\[options\])`
#### `quicsession.openStream([options])`
<!-- YAML
added: REPLACEME
-->
Expand Down Expand Up @@ -1515,7 +1515,7 @@ permitted to close naturally. New `QuicClientSession` and `QuicServerSession`
instances will not be allowed. The returns `Promise` will be resolved once
the `QuicSocket` is destroyed.

#### `quicsocket.connect(\[options\])`
#### `quicsocket.connect([options])`
<!-- YAML
added: REPLACEME
-->
Expand Down Expand Up @@ -1647,7 +1647,7 @@ added: REPLACEME

Returns a `Promise` that resolves a new `QuicClientSession`.

#### `quicsocket.destroy(\[error\])`
#### `quicsocket.destroy([error])`
<!-- YAML
added: REPLACEME
-->
Expand Down Expand Up @@ -1690,7 +1690,7 @@ An array of `QuicEndpoint` instances associated with the `QuicSocket`.

Read-only.

#### `quicsocket.listen(\[options\])`
#### `quicsocket.listen([options])`
<!-- YAML
added: REPLACEME
-->
Expand Down Expand Up @@ -2215,7 +2215,7 @@ The maximum received offset for this `QuicStream`.

Read-only.

#### `quicstream.pushStream(headers\[, options\])`
#### `quicstream.pushStream(headers[, options])`
<!-- YAML
added: REPLACEME
-->
Expand Down Expand Up @@ -2265,7 +2265,7 @@ The `QuicServerSession` or `QuicClientSession` to which the

Read-only.

#### `quicstream.sendFD(fd\[, options\])`
#### `quicstream.sendFD(fd[, options])`
<!-- YAML
added: REPLACEME
-->
Expand All @@ -2291,7 +2291,7 @@ Using the same file descriptor concurrently for multiple streams
is not supported and may result in data loss. Re-using a file descriptor
after a stream has finished is supported.

#### `quicstream.sendFile(path\[, options\])`
#### `quicstream.sendFile(path[, options])`
<!-- YAML
added: REPLACEME
-->
Expand Down