Skip to content

Commit 163176c

Browse files
committed
chore: generating docs
1 parent 94a3b99 commit 163176c

File tree

144 files changed

+3898
-580
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

144 files changed

+3898
-580
lines changed

docs/assets/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/classes/QUICClient.html

Lines changed: 51 additions & 44 deletions
Large diffs are not rendered by default.

docs/classes/QUICConnection.html

Lines changed: 206 additions & 76 deletions
Large diffs are not rendered by default.

docs/classes/QUICServer.html

Lines changed: 55 additions & 48 deletions
Large diffs are not rendered by default.

docs/classes/QUICSocket.html

Lines changed: 46 additions & 46 deletions
Large diffs are not rendered by default.

docs/classes/QUICStream.html

Lines changed: 53 additions & 53 deletions
Large diffs are not rendered by default.

docs/classes/errors.ErrorQUIC.html

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -308,6 +308,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
308308
<li><a href="errors.ErrorQUICClientCreateTimeout.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICClient<wbr/>Create<wbr/>Timeout</span></a></li>
309309
<li><a href="errors.ErrorQUICClientDestroyed.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICClient<wbr/>Destroyed</span></a></li>
310310
<li><a href="errors.ErrorQUICClientInternal.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICClient<wbr/>Internal</span></a></li>
311+
<li><a href="errors.ErrorQUICClientInvalidArgument.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICClient<wbr/>Invalid<wbr/>Argument</span></a></li>
311312
<li><a href="errors.ErrorQUICClientInvalidHost.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICClient<wbr/>Invalid<wbr/>Host</span></a></li>
312313
<li><a href="errors.ErrorQUICClientSocketNotRunning.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICClient<wbr/>Socket<wbr/>Not<wbr/>Running</span></a></li>
313314
<li><a href="errors.ErrorQUICConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICConfig</span></a></li>
@@ -323,13 +324,15 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
323324
<li><a href="errors.ErrorQUICConnectionPeerTLS.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICConnection<wbr/>PeerTLS</span></a></li>
324325
<li><a href="errors.ErrorQUICConnectionStartData.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICConnection<wbr/>Start<wbr/>Data</span></a></li>
325326
<li><a href="errors.ErrorQUICConnectionStartTimeout.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICConnection<wbr/>Start<wbr/>Timeout</span></a></li>
327+
<li><a href="errors.ErrorQUICConnectionStopping.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICConnection<wbr/>Stopping</span></a></li>
326328
<li><a href="errors.ErrorQUICHostInvalid.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICHost<wbr/>Invalid</span></a></li>
327329
<li><a href="errors.ErrorQUICPortInvalid.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICPort<wbr/>Invalid</span></a></li>
328330
<li><a href="errors.ErrorQUICServer.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICServer</span></a></li>
329331
<li><a href="errors.ErrorQUICServerInternal.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICServer<wbr/>Internal</span></a></li>
330332
<li><a href="errors.ErrorQUICServerNewConnection.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICServer<wbr/>New<wbr/>Connection</span></a></li>
331333
<li><a href="errors.ErrorQUICServerNotRunning.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICServer<wbr/>Not<wbr/>Running</span></a></li>
332334
<li><a href="errors.ErrorQUICServerSocketNotRunning.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICServer<wbr/>Socket<wbr/>Not<wbr/>Running</span></a></li>
335+
<li><a href="errors.ErrorQUICServerStopping.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICServer<wbr/>Stopping</span></a></li>
333336
<li><a href="errors.ErrorQUICSocket.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICSocket</span></a></li>
334337
<li><a href="errors.ErrorQUICSocketConnectionsActive.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICSocket<wbr/>Connections<wbr/>Active</span></a></li>
335338
<li><a href="errors.ErrorQUICSocketInternal.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICSocket<wbr/>Internal</span></a></li>
@@ -339,10 +342,12 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
339342
<li><a href="errors.ErrorQUICStream.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICStream</span></a></li>
340343
<li><a href="errors.ErrorQUICStreamDestroyed.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICStream<wbr/>Destroyed</span></a></li>
341344
<li><a href="errors.ErrorQUICStreamInternal.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICStream<wbr/>Internal</span></a></li>
345+
<li><a href="errors.ErrorQUICStreamLimit.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICStream<wbr/>Limit</span></a></li>
342346
<li><a href="errors.ErrorQUICStreamLocalRead.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICStream<wbr/>Local<wbr/>Read</span></a></li>
343347
<li><a href="errors.ErrorQUICStreamLocalWrite.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICStream<wbr/>Local<wbr/>Write</span></a></li>
344348
<li><a href="errors.ErrorQUICStreamPeerRead.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICStream<wbr/>Peer<wbr/>Read</span></a></li>
345-
<li><a href="errors.ErrorQUICStreamPeerWrite.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICStream<wbr/>Peer<wbr/>Write</span></a></li></ul></div></details></li>
349+
<li><a href="errors.ErrorQUICStreamPeerWrite.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICStream<wbr/>Peer<wbr/>Write</span></a></li>
350+
<li><a href="errors.ErrorQUICUndefinedBehaviour.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICUndefined<wbr/>Behaviour</span></a></li></ul></div></details></li>
346351
<li><a href="../modules/events.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>events</span></a></li>
347352
<li><a href="../modules/native.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>native</span></a></li>
348353
<li><a href="../modules/utils.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>utils</span></a></li>

docs/classes/errors.ErrorQUICClient.html

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,11 @@ <h4>Hierarchy</h4>
3131
<li><a href="errors.ErrorQUICClientDestroyed.html" class="tsd-signature-type tsd-kind-class">ErrorQUICClientDestroyed</a></li>
3232
<li><a href="errors.ErrorQUICClientCreateTimeout.html" class="tsd-signature-type tsd-kind-class">ErrorQUICClientCreateTimeout</a></li>
3333
<li><a href="errors.ErrorQUICClientSocketNotRunning.html" class="tsd-signature-type tsd-kind-class">ErrorQUICClientSocketNotRunning</a></li>
34+
<li><a href="errors.ErrorQUICClientInvalidArgument.html" class="tsd-signature-type tsd-kind-class">ErrorQUICClientInvalidArgument</a></li>
3435
<li><a href="errors.ErrorQUICClientInvalidHost.html" class="tsd-signature-type tsd-kind-class">ErrorQUICClientInvalidHost</a></li>
3536
<li><a href="errors.ErrorQUICClientInternal.html" class="tsd-signature-type tsd-kind-class">ErrorQUICClientInternal</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources">
3637
<ul>
37-
<li>Defined in <a href="https://github.com/MatrixAI/js-quic/blob/master/src/errors.ts#L45">src/errors.ts:45</a></li></ul></aside>
38+
<li>Defined in <a href="https://github.com/MatrixAI/js-quic/blob/master/src/errors.ts#L49">src/errors.ts:49</a></li></ul></aside>
3839
<section class="tsd-panel-group tsd-index-group">
3940
<section class="tsd-panel tsd-index-panel">
4041
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -150,7 +151,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <s
150151
<div class="tsd-signature"><span class="tsd-kind-property">description</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;QUIC Client error&#39;</span></div><aside class="tsd-sources">
151152
<p>Overrides <a href="errors.ErrorQUIC.html">ErrorQUIC</a>.<a href="errors.ErrorQUIC.html#description">description</a></p>
152153
<ul>
153-
<li>Defined in <a href="https://github.com/MatrixAI/js-quic/blob/master/src/errors.ts#L46">src/errors.ts:46</a></li></ul></aside></section>
154+
<li>Defined in <a href="https://github.com/MatrixAI/js-quic/blob/master/src/errors.ts#L50">src/errors.ts:50</a></li></ul></aside></section>
154155
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a>
155156
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
156157
<div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div>
@@ -306,6 +307,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
306307
<li><a href="errors.ErrorQUICClientCreateTimeout.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICClient<wbr/>Create<wbr/>Timeout</span></a></li>
307308
<li><a href="errors.ErrorQUICClientDestroyed.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICClient<wbr/>Destroyed</span></a></li>
308309
<li><a href="errors.ErrorQUICClientInternal.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICClient<wbr/>Internal</span></a></li>
310+
<li><a href="errors.ErrorQUICClientInvalidArgument.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICClient<wbr/>Invalid<wbr/>Argument</span></a></li>
309311
<li><a href="errors.ErrorQUICClientInvalidHost.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICClient<wbr/>Invalid<wbr/>Host</span></a></li>
310312
<li><a href="errors.ErrorQUICClientSocketNotRunning.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICClient<wbr/>Socket<wbr/>Not<wbr/>Running</span></a></li>
311313
<li><a href="errors.ErrorQUICConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICConfig</span></a></li>
@@ -321,13 +323,15 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
321323
<li><a href="errors.ErrorQUICConnectionPeerTLS.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICConnection<wbr/>PeerTLS</span></a></li>
322324
<li><a href="errors.ErrorQUICConnectionStartData.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICConnection<wbr/>Start<wbr/>Data</span></a></li>
323325
<li><a href="errors.ErrorQUICConnectionStartTimeout.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICConnection<wbr/>Start<wbr/>Timeout</span></a></li>
326+
<li><a href="errors.ErrorQUICConnectionStopping.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICConnection<wbr/>Stopping</span></a></li>
324327
<li><a href="errors.ErrorQUICHostInvalid.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICHost<wbr/>Invalid</span></a></li>
325328
<li><a href="errors.ErrorQUICPortInvalid.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICPort<wbr/>Invalid</span></a></li>
326329
<li><a href="errors.ErrorQUICServer.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICServer</span></a></li>
327330
<li><a href="errors.ErrorQUICServerInternal.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICServer<wbr/>Internal</span></a></li>
328331
<li><a href="errors.ErrorQUICServerNewConnection.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICServer<wbr/>New<wbr/>Connection</span></a></li>
329332
<li><a href="errors.ErrorQUICServerNotRunning.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICServer<wbr/>Not<wbr/>Running</span></a></li>
330333
<li><a href="errors.ErrorQUICServerSocketNotRunning.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICServer<wbr/>Socket<wbr/>Not<wbr/>Running</span></a></li>
334+
<li><a href="errors.ErrorQUICServerStopping.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICServer<wbr/>Stopping</span></a></li>
331335
<li><a href="errors.ErrorQUICSocket.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICSocket</span></a></li>
332336
<li><a href="errors.ErrorQUICSocketConnectionsActive.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICSocket<wbr/>Connections<wbr/>Active</span></a></li>
333337
<li><a href="errors.ErrorQUICSocketInternal.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICSocket<wbr/>Internal</span></a></li>
@@ -337,10 +341,12 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
337341
<li><a href="errors.ErrorQUICStream.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICStream</span></a></li>
338342
<li><a href="errors.ErrorQUICStreamDestroyed.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICStream<wbr/>Destroyed</span></a></li>
339343
<li><a href="errors.ErrorQUICStreamInternal.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICStream<wbr/>Internal</span></a></li>
344+
<li><a href="errors.ErrorQUICStreamLimit.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICStream<wbr/>Limit</span></a></li>
340345
<li><a href="errors.ErrorQUICStreamLocalRead.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICStream<wbr/>Local<wbr/>Read</span></a></li>
341346
<li><a href="errors.ErrorQUICStreamLocalWrite.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICStream<wbr/>Local<wbr/>Write</span></a></li>
342347
<li><a href="errors.ErrorQUICStreamPeerRead.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICStream<wbr/>Peer<wbr/>Read</span></a></li>
343-
<li><a href="errors.ErrorQUICStreamPeerWrite.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICStream<wbr/>Peer<wbr/>Write</span></a></li></ul></div></details></li>
348+
<li><a href="errors.ErrorQUICStreamPeerWrite.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICStream<wbr/>Peer<wbr/>Write</span></a></li>
349+
<li><a href="errors.ErrorQUICUndefinedBehaviour.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>ErrorQUICUndefined<wbr/>Behaviour</span></a></li></ul></div></details></li>
344350
<li><a href="../modules/events.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>events</span></a></li>
345351
<li><a href="../modules/native.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>native</span></a></li>
346352
<li><a href="../modules/utils.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>utils</span></a></li>

0 commit comments

Comments
 (0)