249
249
250
250
## QUIC JavaScript API
251
251
252
- ### ` net.createQuicSocket(\ [options\ ]) `
252
+ ### ` net.createQuicSocket([options]) `
253
253
<!-- YAML
254
254
added: REPLACEME
255
255
-->
@@ -336,7 +336,7 @@ The object will contain the properties:
336
336
337
337
If the ` QuicEndpoint ` is not bound, ` quicendpoint.address ` is an empty object.
338
338
339
- #### ` quicendpoint.bind(\ [options\ ]) `
339
+ #### ` quicendpoint.bind([options]) `
340
340
<!-- YAML
341
341
added: REPLACEME
342
342
-->
@@ -396,7 +396,7 @@ added: REPLACEME
396
396
397
397
Set to ` true ` if the ` QuicEndpoint ` is in the process of closing.
398
398
399
- #### ` quicendpoint.destroy(\ [error\ ]) `
399
+ #### ` quicendpoint.destroy([error]) `
400
400
<!-- YAML
401
401
added: REPLACEME
402
402
-->
@@ -455,7 +455,7 @@ the local UDP port.
455
455
added: REPLACEME
456
456
-->
457
457
458
- #### ` quicendpoint.setBroadcast(\ [on\ ]) `
458
+ #### ` quicendpoint.setBroadcast([on]) `
459
459
<!-- YAML
460
460
added: REPLACEME
461
461
-->
@@ -552,7 +552,7 @@ A socket's address family's ANY address (IPv4 `'0.0.0.0'` or IPv6 `'::'`)
552
552
can be used to return control of the sockets default outgoing interface to
553
553
the system for future multicast packets.
554
554
555
- #### ` quicendpoint.setMulticastLoopback(\ [on\ ]) `
555
+ #### ` quicendpoint.setMulticastLoopback([on]) `
556
556
<!-- YAML
557
557
added: REPLACEME
558
558
-->
@@ -844,7 +844,7 @@ added: REPLACEME
844
844
845
845
Set to ` true ` if the ` QuicSession ` is in the process of a graceful shutdown.
846
846
847
- #### ` quicsession.destroy(\ [error\ ]) `
847
+ #### ` quicsession.destroy([error]) `
848
848
<!-- YAML
849
849
added: REPLACEME
850
850
-->
@@ -888,7 +888,7 @@ some properties corresponding to the fields of the certificate.
888
888
If there is no local certificate, or if the ` QuicSession ` has been destroyed,
889
889
an empty object will be returned.
890
890
891
- #### ` quicsession.getPeerCertificate(\ [detailed\ ]) `
891
+ #### ` quicsession.getPeerCertificate([detailed]) `
892
892
<!-- YAML
893
893
added: REPLACEME
894
894
-->
@@ -1025,7 +1025,7 @@ added: REPLACEME
1025
1025
1026
1026
The minimum RTT recorded so far for this ` QuicSession ` .
1027
1027
1028
- #### ` quicsession.openStream(\ [options\ ]) `
1028
+ #### ` quicsession.openStream([options]) `
1029
1029
<!-- YAML
1030
1030
added: REPLACEME
1031
1031
-->
@@ -1515,7 +1515,7 @@ permitted to close naturally. New `QuicClientSession` and `QuicServerSession`
1515
1515
instances will not be allowed. The returns ` Promise ` will be resolved once
1516
1516
the ` QuicSocket ` is destroyed.
1517
1517
1518
- #### ` quicsocket.connect(\ [options\ ]) `
1518
+ #### ` quicsocket.connect([options]) `
1519
1519
<!-- YAML
1520
1520
added: REPLACEME
1521
1521
-->
@@ -1647,7 +1647,7 @@ added: REPLACEME
1647
1647
1648
1648
Returns a ` Promise ` that resolves a new ` QuicClientSession ` .
1649
1649
1650
- #### ` quicsocket.destroy(\ [error\ ]) `
1650
+ #### ` quicsocket.destroy([error]) `
1651
1651
<!-- YAML
1652
1652
added: REPLACEME
1653
1653
-->
@@ -1690,7 +1690,7 @@ An array of `QuicEndpoint` instances associated with the `QuicSocket`.
1690
1690
1691
1691
Read-only.
1692
1692
1693
- #### ` quicsocket.listen(\ [options\ ]) `
1693
+ #### ` quicsocket.listen([options]) `
1694
1694
<!-- YAML
1695
1695
added: REPLACEME
1696
1696
-->
@@ -2215,7 +2215,7 @@ The maximum received offset for this `QuicStream`.
2215
2215
2216
2216
Read-only.
2217
2217
2218
- #### ` quicstream.pushStream(headers\ [, options\ ]) `
2218
+ #### ` quicstream.pushStream(headers[, options]) `
2219
2219
<!-- YAML
2220
2220
added: REPLACEME
2221
2221
-->
@@ -2265,7 +2265,7 @@ The `QuicServerSession` or `QuicClientSession` to which the
2265
2265
2266
2266
Read-only.
2267
2267
2268
- #### ` quicstream.sendFD(fd\ [, options\ ]) `
2268
+ #### ` quicstream.sendFD(fd[, options]) `
2269
2269
<!-- YAML
2270
2270
added: REPLACEME
2271
2271
-->
@@ -2291,7 +2291,7 @@ Using the same file descriptor concurrently for multiple streams
2291
2291
is not supported and may result in data loss. Re-using a file descriptor
2292
2292
after a stream has finished is supported.
2293
2293
2294
- #### ` quicstream.sendFile(path\ [, options\ ]) `
2294
+ #### ` quicstream.sendFile(path[, options]) `
2295
2295
<!-- YAML
2296
2296
added: REPLACEME
2297
2297
-->
0 commit comments