Source Code: lib/quic.js
\nThe 'node:quic' module provides an implementation of the QUIC protocol.\nTo access it, start Node.js with the --experimental-quic option and:
import quic from 'node:quic';\nconst quic = require('node:quic');\nThe module is only available under the node: scheme.
Initiate a new client-side session.
\nimport { connect } from 'node:quic';\nimport { Buffer } from 'node:buffer';\n\nconst enc = new TextEncoder();\nconst alpn = 'foo';\nconst client = await connect('123.123.123.123:8888', { alpn });\nawait client.createUnidirectionalStream({\n body: enc.encode('hello world'),\n});\nBy default, every call to connect(...) will create a new local\nQuicEndpoint instance bound to a new random local IP port. To\nspecify the exact local address to use, or to multiplex multiple\nQUIC sessions over a single local port, pass the endpoint option\nwith either a QuicEndpoint or EndpointOptions as the argument.
import { QuicEndpoint, connect } from 'node:quic';\n\nconst endpoint = new QuicEndpoint({\n address: '127.0.0.1:1234',\n});\n\nconst client = await connect('123.123.123.123:8888', { endpoint });\nConfigures the endpoint to listen as a server. When a new session is initiated by\na remote peer, the given onsession callback will be invoked with the created\nsession.
import { listen } from 'node:quic';\n\nconst endpoint = await listen((session) => {\n // ... handle the session\n});\n\n// Closing the endpoint allows any sessions open when close is called\n// to complete naturally while preventing new sessions from being\n// initiated. Once all existing sessions have finished, the endpoint\n// will be destroyed. The call returns a promise that is resolved once\n// the endpoint is destroyed.\nawait endpoint.close();\nBy default, every call to listen(...) will create a new local\nQuicEndpoint instance bound to a new random local IP port. To\nspecify the exact local address to use, or to multiplex multiple\nQUIC sessions over a single local port, pass the endpoint option\nwith either a QuicEndpoint or EndpointOptions as the argument.
At most, any single QuicEndpoint can only be configured to listen as\na server once.
A QuicEndpoint encapsulates the local UDP-port binding for QUIC. It can be\nused as both a client and a server.
The local UDP socket address to which the endpoint is bound, if any.
\nIf the endpoint is not currently bound then the value will be undefined. Read only.
When endpoint.busy is set to true, the endpoint will temporarily reject\nnew sessions from being created. Read/write.
// Mark the endpoint busy. New sessions will be prevented.\nendpoint.busy = true;\n\n// Mark the endpoint free. New session will be allowed.\nendpoint.busy = false;\nThe busy property is useful when the endpoint is under heavy load and needs to\ntemporarily reject new sessions while it catches up.
A promise that is fulfilled when the endpoint is destroyed. This will be the same promise that is\nreturned by the endpoint.close() function. Read only.
True if endpoint.close() has been called and closing the endpoint has not yet completed.\nRead only.
True if endpoint.destroy() has been called. Read only.
The statistics collected for an active session. Read only.
" } ], "methods": [ { "textRaw": "`endpoint.close()`", "type": "method", "name": "close", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "signatures": [ { "return": { "textRaw": "Returns: {Promise}", "name": "return", "type": "Promise" }, "params": [] } ], "desc": "Gracefully close the endpoint. The endpoint will close and destroy itself when\nall currently open sessions close. Once called, new sessions will be rejected.
\nReturns a promise that is fulfilled when the endpoint is destroyed.
" }, { "textRaw": "`endpoint.destroy([error])`", "type": "method", "name": "destroy", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "signatures": [ { "params": [ { "textRaw": "`error` {any}", "name": "error", "type": "any" } ] } ], "desc": "Forcefully closes the endpoint by forcing all open sessions to be immediately\nclosed.
" }, { "textRaw": "`endpoint[Symbol.asyncDispose]()`", "type": "method", "name": "[Symbol.asyncDispose]", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "signatures": [ { "params": [] } ], "desc": "Calls endpoint.close() and returns a promise that fulfills when the\nendpoint has closed.
A view of the collected statistics for an endpoint.
", "properties": [ { "textRaw": "`createdAt` {bigint} A timestamp indicating the moment the endpoint was created. Read only.", "type": "bigint", "name": "createdAt", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "A timestamp indicating the moment the endpoint was created. Read only." }, { "textRaw": "`destroyedAt` {bigint} A timestamp indicating the moment the endpoint was destroyed. Read only.", "type": "bigint", "name": "destroyedAt", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "A timestamp indicating the moment the endpoint was destroyed. Read only." }, { "textRaw": "`bytesReceived` {bigint} The total number of bytes received by this endpoint. Read only.", "type": "bigint", "name": "bytesReceived", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The total number of bytes received by this endpoint. Read only." }, { "textRaw": "`bytesSent` {bigint} The total number of bytes sent by this endpoint. Read only.", "type": "bigint", "name": "bytesSent", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The total number of bytes sent by this endpoint. Read only." }, { "textRaw": "`packetsReceived` {bigint} The total number of QUIC packets successfully received by this endpoint. Read only.", "type": "bigint", "name": "packetsReceived", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The total number of QUIC packets successfully received by this endpoint. Read only." }, { "textRaw": "`packetsSent` {bigint} The total number of QUIC packets successfully sent by this endpoint. Read only.", "type": "bigint", "name": "packetsSent", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The total number of QUIC packets successfully sent by this endpoint. Read only." }, { "textRaw": "`serverSessions` {bigint} The total number of peer-initiated sessions received by this endpoint. Read only.", "type": "bigint", "name": "serverSessions", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The total number of peer-initiated sessions received by this endpoint. Read only." }, { "textRaw": "`clientSessions` {bigint} The total number of sessions initiated by this endpoint. Read only.", "type": "bigint", "name": "clientSessions", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The total number of sessions initiated by this endpoint. Read only." }, { "textRaw": "`serverBusyCount` {bigint} The total number of times an initial packet was rejected due to the endpoint being marked busy. Read only.", "type": "bigint", "name": "serverBusyCount", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The total number of times an initial packet was rejected due to the endpoint being marked busy. Read only." }, { "textRaw": "`retryCount` {bigint} The total number of QUIC retry attempts on this endpoint. Read only.", "type": "bigint", "name": "retryCount", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The total number of QUIC retry attempts on this endpoint. Read only." }, { "textRaw": "`versionNegotiationCount` {bigint} The total number sessions rejected due to QUIC version mismatch. Read only.", "type": "bigint", "name": "versionNegotiationCount", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The total number sessions rejected due to QUIC version mismatch. Read only." }, { "textRaw": "`statelessResetCount` {bigint} The total number of stateless resets handled by this endpoint. Read only.", "type": "bigint", "name": "statelessResetCount", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The total number of stateless resets handled by this endpoint. Read only." }, { "textRaw": "`immediateCloseCount` {bigint} The total number of sessions that were closed before handshake completed. Read only.", "type": "bigint", "name": "immediateCloseCount", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The total number of sessions that were closed before handshake completed. Read only." } ] }, { "textRaw": "Class: `QuicSession`", "type": "class", "name": "QuicSession", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "A QuicSession represents the local side of a QUIC connection.
Initiate a graceful close of the session. Existing streams will be allowed\nto complete but no new streams will be opened. Once all streams have closed,\nthe session will be destroyed. The returned promise will be fulfilled once\nthe session has been destroyed.
" }, { "textRaw": "`session.destroy([error])`", "type": "method", "name": "destroy", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "signatures": [ { "params": [ { "textRaw": "`error` {any}", "name": "error", "type": "any" } ] } ], "desc": "Immediately destroy the session. All streams will be destroys and the\nsession will be closed.
" }, { "textRaw": "`session.createBidirectionalStream([options])`", "type": "method", "name": "createBidirectionalStream", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "signatures": [ { "return": { "textRaw": "Returns: {Promise} for a {quic.QuicStream}", "name": "return", "type": "Promise", "desc": "for a {quic.QuicStream}" }, "params": [ { "textRaw": "`options` {Object}", "name": "options", "type": "Object", "options": [ { "textRaw": "`body` {ArrayBuffer | ArrayBufferView | Blob}", "name": "body", "type": "ArrayBuffer | ArrayBufferView | Blob" }, { "textRaw": "`sendOrder` {number}", "name": "sendOrder", "type": "number" } ] } ] } ], "desc": "Open a new bidirectional stream. If the body option is not specified,\nthe outgoing stream will be half-closed.
Open a new unidirectional stream. If the body option is not specified,\nthe outgoing stream will be closed.
Sends an unreliable datagram to the remote peer, returning the datagram ID.\nIf the datagram payload is specified as an ArrayBufferView, then ownership of\nthat view will be transfered to the underlying stream.
Initiate a key update for the session.
" }, { "textRaw": "`session[Symbol.asyncDispose]()`", "type": "method", "name": "[Symbol.asyncDispose]", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "signatures": [ { "params": [] } ], "desc": "Calls session.close() and returns a promise that fulfills when the\nsession has closed.
A promise that is fulfilled once the session is destroyed.
" }, { "textRaw": "`destroyed` {boolean}", "type": "boolean", "name": "destroyed", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "True if session.destroy() has been called. Read only.
The endpoint that created this session. Read only.
" }, { "textRaw": "`onstream` {quic.OnStreamCallback}", "type": "quic.OnStreamCallback", "name": "onstream", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The callback to invoke when a new stream is initiated by a remote peer. Read/write.
" }, { "textRaw": "`ondatagram` {quic.OnDatagramCallback}", "type": "quic.OnDatagramCallback", "name": "ondatagram", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The callback to invoke when a new datagram is received from a remote peer. Read/write.
" }, { "textRaw": "`ondatagramstatus` {quic.OnDatagramStatusCallback}", "type": "quic.OnDatagramStatusCallback", "name": "ondatagramstatus", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The callback to invoke when the status of a datagram is updated. Read/write.
" }, { "textRaw": "`onpathvalidation` {quic.OnPathValidationCallback}", "type": "quic.OnPathValidationCallback", "name": "onpathvalidation", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The callback to invoke when the path validation is updated. Read/write.
" }, { "textRaw": "`onsessionticket` {quic.OnSessionTicketCallback}", "type": "quic.OnSessionTicketCallback", "name": "onsessionticket", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The callback to invoke when a new session ticket is received. Read/write.
" }, { "textRaw": "`onversionnegotiation` {quic.OnVersionNegotiationCallback}", "type": "quic.OnVersionNegotiationCallback", "name": "onversionnegotiation", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The callback to invoke when a version negotiation is initiated. Read/write.
" }, { "textRaw": "`onhandshake` {quic.OnHandshakeCallback}", "type": "quic.OnHandshakeCallback", "name": "onhandshake", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The callback to invoke when the TLS handshake is completed. Read/write.
" }, { "textRaw": "`path` {Object|undefined}", "type": "Object|undefined", "name": "path", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "options": [ { "textRaw": "`local` {net.SocketAddress}", "name": "local", "type": "net.SocketAddress" }, { "textRaw": "`remote` {net.SocketAddress}", "name": "remote", "type": "net.SocketAddress" } ], "desc": "The local and remote socket addresses associated with the session. Read only.
" }, { "textRaw": "`stats` {quic.QuicSession.Stats}", "type": "quic.QuicSession.Stats", "name": "stats", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "Return the current statistics for the session. Read only.
" } ] }, { "textRaw": "Class: `QuicSession.Stats`", "type": "class", "name": "QuicSession.Stats", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "properties": [ { "textRaw": "`createdAt` {bigint}", "type": "bigint", "name": "createdAt", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`closingAt` {bigint}", "type": "bigint", "name": "closingAt", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`handshakeCompletedAt` {bigint}", "type": "bigint", "name": "handshakeCompletedAt", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`handshakeConfirmedAt` {bigint}", "type": "bigint", "name": "handshakeConfirmedAt", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`bytesReceived` {bigint}", "type": "bigint", "name": "bytesReceived", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`bytesSent` {bigint}", "type": "bigint", "name": "bytesSent", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`bidiInStreamCount` {bigint}", "type": "bigint", "name": "bidiInStreamCount", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`bidiOutStreamCount` {bigint}", "type": "bigint", "name": "bidiOutStreamCount", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`uniInStreamCount` {bigint}", "type": "bigint", "name": "uniInStreamCount", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`uniOutStreamCount` {bigint}", "type": "bigint", "name": "uniOutStreamCount", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`maxBytesInFlights` {bigint}", "type": "bigint", "name": "maxBytesInFlights", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`bytesInFlight` {bigint}", "type": "bigint", "name": "bytesInFlight", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`blockCount` {bigint}", "type": "bigint", "name": "blockCount", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`cwnd` {bigint}", "type": "bigint", "name": "cwnd", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`latestRtt` {bigint}", "type": "bigint", "name": "latestRtt", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`minRtt` {bigint}", "type": "bigint", "name": "minRtt", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`rttVar` {bigint}", "type": "bigint", "name": "rttVar", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`smoothedRtt` {bigint}", "type": "bigint", "name": "smoothedRtt", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`ssthresh` {bigint}", "type": "bigint", "name": "ssthresh", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`datagramsReceived` {bigint}", "type": "bigint", "name": "datagramsReceived", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`datagramsSent` {bigint}", "type": "bigint", "name": "datagramsSent", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`datagramsAcknowledged` {bigint}", "type": "bigint", "name": "datagramsAcknowledged", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`datagramsLost` {bigint}", "type": "bigint", "name": "datagramsLost", "meta": { "added": [ "v23.8.0" ], "changes": [] } } ] }, { "textRaw": "Class: `QuicStream`", "type": "class", "name": "QuicStream", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "properties": [ { "textRaw": "`closed` {Promise}", "type": "Promise", "name": "closed", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "A promise that is fulfilled when the stream is fully closed.
" }, { "textRaw": "`destroyed` {boolean}", "type": "boolean", "name": "destroyed", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "True if stream.destroy() has been called.
The directionality of the stream. Read only.
", "shortDesc": "One of either `'bidi'` or `'uni'`." }, { "textRaw": "`id` {bigint}", "type": "bigint", "name": "id", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The stream ID. Read only.
" }, { "textRaw": "`onblocked` {quic.OnBlockedCallback}", "type": "quic.OnBlockedCallback", "name": "onblocked", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The callback to invoke when the stream is blocked. Read/write.
" }, { "textRaw": "`onreset` {quic.OnStreamErrorCallback}", "type": "quic.OnStreamErrorCallback", "name": "onreset", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The callback to invoke when the stream is reset. Read/write.
" }, { "textRaw": "`readable` {ReadableStream}", "type": "ReadableStream", "name": "readable", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`session` {quic.QuicSession}", "type": "quic.QuicSession", "name": "session", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The session that created this stream. Read only.
" }, { "textRaw": "`stats` {quic.QuicStream.Stats}", "type": "quic.QuicStream.Stats", "name": "stats", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The current statistics for the stream. Read only.
" } ], "methods": [ { "textRaw": "`stream.destroy([error])`", "type": "method", "name": "destroy", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "signatures": [ { "params": [ { "textRaw": "`error` {any}", "name": "error", "type": "any" } ] } ], "desc": "Immediately and abruptly destroys the stream.
" } ] }, { "textRaw": "Class: `QuicStream.Stats`", "type": "class", "name": "QuicStream.Stats", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "properties": [ { "textRaw": "`ackedAt` {bigint}", "type": "bigint", "name": "ackedAt", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`bytesReceived` {bigint}", "type": "bigint", "name": "bytesReceived", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`bytesSent` {bigint}", "type": "bigint", "name": "bytesSent", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`createdAt` {bigint}", "type": "bigint", "name": "createdAt", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`destroyedAt` {bigint}", "type": "bigint", "name": "destroyedAt", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`finalSize` {bigint}", "type": "bigint", "name": "finalSize", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`isConnected` {bigint}", "type": "bigint", "name": "isConnected", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`maxOffset` {bigint}", "type": "bigint", "name": "maxOffset", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`maxOffsetAcknowledged` {bigint}", "type": "bigint", "name": "maxOffsetAcknowledged", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`maxOffsetReceived` {bigint}", "type": "bigint", "name": "maxOffsetReceived", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`openedAt` {bigint}", "type": "bigint", "name": "openedAt", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`receivedAt` {bigint}", "type": "bigint", "name": "receivedAt", "meta": { "added": [ "v23.8.0" ], "changes": [] } } ] } ], "modules": [ { "textRaw": "Types", "name": "types", "modules": [ { "textRaw": "Type: `EndpointOptions`", "name": "type:_`endpointoptions`", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The endpoint configuration options passed when constructing a new QuicEndpoint instance.
If not specified the endpoint will bind to IPv4 localhost on a random port.
The endpoint maintains an internal cache of validated socket addresses as a\nperformance optimization. This option sets the maximum number of addresses\nthat are cache. This is an advanced option that users typically won't have\nneed to specify.
" }, { "textRaw": "`ipv6Only` {boolean}", "type": "boolean", "name": "ipv6Only", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "When true, indicates that the endpoint should bind only to IPv6 addresses.
Specifies the maximum number of concurrent sessions allowed per remote peer address.
" }, { "textRaw": "`maxConnectionsTotal` {bigint|number}", "type": "bigint|number", "name": "maxConnectionsTotal", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "Specifies the maximum total number of concurrent sessions.
" }, { "textRaw": "`maxRetries` {bigint|number}", "type": "bigint|number", "name": "maxRetries", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "Specifies the maximum number of QUIC retry attempts allowed per remote peer address.
" }, { "textRaw": "`maxStatelessResetsPerHost` {bigint|number}", "type": "bigint|number", "name": "maxStatelessResetsPerHost", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "Specifies the maximum number of stateless resets that are allowed per remote peer address.
" }, { "textRaw": "`retryTokenExpiration` {bigint|number}", "type": "bigint|number", "name": "retryTokenExpiration", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "Specifies the length of time a QUIC retry token is considered valid.
" }, { "textRaw": "`resetTokenSecret` {ArrayBufferView}", "type": "ArrayBufferView", "name": "resetTokenSecret", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "Specifies the 16-byte secret used to generate QUIC retry tokens.
" }, { "textRaw": "`tokenExpiration` {bigint|number}", "type": "bigint|number", "name": "tokenExpiration", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "Specifies the length of time a QUIC token is considered valid.
" }, { "textRaw": "`tokenSecret` {ArrayBufferView}", "type": "ArrayBufferView", "name": "tokenSecret", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "Specifies the 16-byte secret used to generate QUIC tokens.
" }, { "textRaw": "`udpReceiveBufferSize` {number}", "type": "number", "name": "udpReceiveBufferSize", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`udpSendBufferSize` {number}", "type": "number", "name": "udpSendBufferSize", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`udpTTL` {number}", "type": "number", "name": "udpTTL", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`validateAddress` {boolean}", "type": "boolean", "name": "validateAddress", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "When true, requires that the endpoint validate peer addresses using retry packets\nwhile establishing a new connection.
The ALPN protocol identifier.
" }, { "textRaw": "`ca` {ArrayBuffer|ArrayBufferView|ArrayBuffer\\[]|ArrayBufferView\\[]}", "type": "ArrayBuffer|ArrayBufferView|ArrayBuffer\\[]|ArrayBufferView\\[]", "name": "ca", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The CA certificates to use for sessions.
" }, { "textRaw": "`cc` {string}", "type": "string", "name": "cc", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "Specifies the congestion control algorithm that will be used\n. Must be set to one of either 'reno', 'cubic', or 'bbr'.
This is an advanced option that users typically won't have need to specify.
" }, { "textRaw": "`certs` {ArrayBuffer|ArrayBufferView|ArrayBuffer\\[]|ArrayBufferView\\[]}", "type": "ArrayBuffer|ArrayBufferView|ArrayBuffer\\[]|ArrayBufferView\\[]", "name": "certs", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The TLS certificates to use for sessions.
" }, { "textRaw": "`ciphers` {string}", "type": "string", "name": "ciphers", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The list of supported TLS 1.3 cipher algorithms.
" }, { "textRaw": "`crl` {ArrayBuffer|ArrayBufferView|ArrayBuffer\\[]|ArrayBufferView\\[]}", "type": "ArrayBuffer|ArrayBufferView|ArrayBuffer\\[]|ArrayBufferView\\[]", "name": "crl", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The CRL to use for sessions.
" }, { "textRaw": "`groups` {string}", "type": "string", "name": "groups", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The list of support TLS 1.3 cipher groups.
" }, { "textRaw": "`keylog` {boolean}", "type": "boolean", "name": "keylog", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "True to enable TLS keylogging output.
" }, { "textRaw": "`keys` {KeyObject|CryptoKey|KeyObject\\[]|CryptoKey\\[]}", "type": "KeyObject|CryptoKey|KeyObject\\[]|CryptoKey\\[]", "name": "keys", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The TLS crypto keys to use for sessions.
" }, { "textRaw": "`maxPayloadSize` {bigint|number}", "type": "bigint|number", "name": "maxPayloadSize", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "Specifies the maximum UDP packet payload size.
" }, { "textRaw": "`maxStreamWindow` {bigint|number}", "type": "bigint|number", "name": "maxStreamWindow", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "Specifies the maximum stream flow-control window size.
" }, { "textRaw": "`maxWindow` {bigint|number}", "type": "bigint|number", "name": "maxWindow", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "Specifies the maxumum session flow-control window size.
" }, { "textRaw": "`minVersion` {number}", "type": "number", "name": "minVersion", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The minimum QUIC version number to allow. This is an advanced option that users\ntypically won't have need to specify.
" }, { "textRaw": "`preferredAddressPolicy` {string} One of `'use'`, `'ignore'`, or `'default'`.", "type": "string", "name": "preferredAddressPolicy", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "When the remote peer advertises a preferred address, this option specifies whether\nto use it or ignore it.
", "shortDesc": "One of `'use'`, `'ignore'`, or `'default'`." }, { "textRaw": "`qlog` {boolean}", "type": "boolean", "name": "qlog", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "True if qlog output should be enabled.
" }, { "textRaw": "`sessionTicket` {ArrayBufferView} A session ticket to use for 0RTT session resumption.", "type": "ArrayBufferView", "name": "sessionTicket", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "A session ticket to use for 0RTT session resumption." }, { "textRaw": "`handshakeTimeout` {bigint|number}", "type": "bigint|number", "name": "handshakeTimeout", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "Specifies the maximum number of milliseconds a TLS handshake is permitted to take\nto complete before timing out.
" }, { "textRaw": "`sni` {string}", "type": "string", "name": "sni", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The peer server name to target.
" }, { "textRaw": "`tlsTrace` {boolean}", "type": "boolean", "name": "tlsTrace", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "True to enable TLS tracing output.
" }, { "textRaw": "`transportParams` {quic.TransportParams}", "type": "quic.TransportParams", "name": "transportParams", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The QUIC transport parameters to use for the session.
" }, { "textRaw": "`unacknowledgedPacketThreshold` {bigint|number}", "type": "bigint|number", "name": "unacknowledgedPacketThreshold", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "Specifies the maximum number of unacknowledged packets a session should allow.
" }, { "textRaw": "`verifyClient` {boolean}", "type": "boolean", "name": "verifyClient", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "True to require verification of TLS client certificate.
" }, { "textRaw": "`verifyPrivateKey` {boolean}", "type": "boolean", "name": "verifyPrivateKey", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "True to require private key verification.
" }, { "textRaw": "`version` {number}", "type": "number", "name": "version", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The QUIC version number to use. This is an advanced option that users typically\nwon't have need to specify.
" } ], "type": "module", "displayName": "Type: `SessionOptions`" }, { "textRaw": "Type: `TransportParams`", "name": "type:_`transportparams`", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "properties": [ { "textRaw": "`preferredAddressIpv4` {net.SocketAddress} The preferred IPv4 address to advertise.", "type": "net.SocketAddress", "name": "preferredAddressIpv4", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The preferred IPv4 address to advertise." }, { "textRaw": "`preferredAddressIpv6` {net.SocketAddress} The preferred IPv6 address to advertise.", "type": "net.SocketAddress", "name": "preferredAddressIpv6", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "The preferred IPv6 address to advertise." }, { "textRaw": "`initialMaxStreamDataBidiLocal` {bigint|number}", "type": "bigint|number", "name": "initialMaxStreamDataBidiLocal", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`initialMaxStreamDataBidiRemote` {bigint|number}", "type": "bigint|number", "name": "initialMaxStreamDataBidiRemote", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`initialMaxStreamDataUni` {bigint|number}", "type": "bigint|number", "name": "initialMaxStreamDataUni", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`initialMaxData` {bigint|number}", "type": "bigint|number", "name": "initialMaxData", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`initialMaxStreamsBidi` {bigint|number}", "type": "bigint|number", "name": "initialMaxStreamsBidi", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`initialMaxStreamsUni` {bigint|number}", "type": "bigint|number", "name": "initialMaxStreamsUni", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`maxIdleTimeout` {bigint|number}", "type": "bigint|number", "name": "maxIdleTimeout", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`activeConnectionIDLimit` {bigint|number}", "type": "bigint|number", "name": "activeConnectionIDLimit", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`ackDelayExponent` {bigint|number}", "type": "bigint|number", "name": "ackDelayExponent", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`maxAckDelay` {bigint|number}", "type": "bigint|number", "name": "maxAckDelay", "meta": { "added": [ "v23.8.0" ], "changes": [] } }, { "textRaw": "`maxDatagramFrameSize` {bigint|number}", "type": "bigint|number", "name": "maxDatagramFrameSize", "meta": { "added": [ "v23.8.0" ], "changes": [] } } ], "type": "module", "displayName": "Type: `TransportParams`" } ], "type": "module", "displayName": "Types" }, { "textRaw": "Callbacks", "name": "callbacks", "modules": [ { "textRaw": "Callback: `OnSessionCallback`", "name": "callback:_`onsessioncallback`", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "this <quic.QuicEndpoint>session <quic.QuicSession>The callback function that is invoked when a new session is initiated by a remote peer.
", "type": "module", "displayName": "Callback: `OnSessionCallback`" }, { "textRaw": "Callback: `OnStreamCallback`", "name": "callback:_`onstreamcallback`", "meta": { "added": [ "v23.8.0" ], "changes": [] }, "desc": "this <quic.QuicSession>stream <quic.QuicStream>this <quic.QuicSession>datagram <Uint8Array>early <boolean>this <quic.QuicSession>id <bigint>status <string> One of either 'lost' or 'acknowledged'.this <quic.QuicSession>result <string> One of either 'success', 'failure', or 'aborted'.newLocalAddress <net.SocketAddress>newRemoteAddress <net.SocketAddress>oldLocalAddress <net.SocketAddress>oldRemoteAddress <net.SocketAddress>preferredAddress <boolean>this <quic.QuicSession>ticket <Object>this <quic.QuicSession>version <number>requestedVersions <number[]>supportedVersions <number[]>this <quic.QuicSession>sni <string>alpn <string>cipher <string>cipherVersion <string>validationErrorReason <string>validationErrorCode <number>earlyDataAccepted <boolean>this <quic.QuicStream>this <quic.QuicStream>error <any>endpoint <quic.QuicEndpoint>config <quic.EndpointOptions>endpoint <quic.QuicEndpoint>optoins <quic.SessionOptions>endpoint <quic.QuicEndpoint>hasPendingError <boolean>endpoint <quic.QuicEndpoint>endpoint <quic.QuicEndpoint>error <any>endpoint <quic.QuicEndpoint>busy <boolean>