Skip to content

Commit 7a1220a

Browse files
addaleaxTrott
authored andcommitted
doc: fix headings in quic.md
PR-URL: #34717 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Rich Trott <[email protected]>
1 parent f948359 commit 7a1220a

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

doc/api/quic.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ TBD
249249

250250
## QUIC JavaScript API
251251

252-
### `net.createQuicSocket(\[options\])`
252+
### `net.createQuicSocket([options])`
253253
<!-- YAML
254254
added: REPLACEME
255255
-->
@@ -336,7 +336,7 @@ The object will contain the properties:
336336

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

339-
#### `quicendpoint.bind(\[options\])`
339+
#### `quicendpoint.bind([options])`
340340
<!-- YAML
341341
added: REPLACEME
342342
-->
@@ -396,7 +396,7 @@ added: REPLACEME
396396

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

399-
#### `quicendpoint.destroy(\[error\])`
399+
#### `quicendpoint.destroy([error])`
400400
<!-- YAML
401401
added: REPLACEME
402402
-->
@@ -455,7 +455,7 @@ the local UDP port.
455455
added: REPLACEME
456456
-->
457457

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

555-
#### `quicendpoint.setMulticastLoopback(\[on\])`
555+
#### `quicendpoint.setMulticastLoopback([on])`
556556
<!-- YAML
557557
added: REPLACEME
558558
-->
@@ -844,7 +844,7 @@ added: REPLACEME
844844

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

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

891-
#### `quicsession.getPeerCertificate(\[detailed\])`
891+
#### `quicsession.getPeerCertificate([detailed])`
892892
<!-- YAML
893893
added: REPLACEME
894894
-->
@@ -1025,7 +1025,7 @@ added: REPLACEME
10251025

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

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

1518-
#### `quicsocket.connect(\[options\])`
1518+
#### `quicsocket.connect([options])`
15191519
<!-- YAML
15201520
added: REPLACEME
15211521
-->
@@ -1647,7 +1647,7 @@ added: REPLACEME
16471647

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

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

16911691
Read-only.
16921692

1693-
#### `quicsocket.listen(\[options\])`
1693+
#### `quicsocket.listen([options])`
16941694
<!-- YAML
16951695
added: REPLACEME
16961696
-->
@@ -2215,7 +2215,7 @@ The maximum received offset for this `QuicStream`.
22152215

22162216
Read-only.
22172217

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

22662266
Read-only.
22672267

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

2294-
#### `quicstream.sendFile(path\[, options\])`
2294+
#### `quicstream.sendFile(path[, options])`
22952295
<!-- YAML
22962296
added: REPLACEME
22972297
-->

0 commit comments

Comments
 (0)