Skip to content

Commit b25f22a

Browse files
CMCDragonkaiCMCDragonkai
committed
docs: updated docs
1 parent 9c20117 commit b25f22a

File tree

91 files changed

+1342
-458
lines changed

Some content is hidden

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

91 files changed

+1342
-458
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: 34 additions & 34 deletions
Large diffs are not rendered by default.

‎docs/classes/QUICConnection.html‎

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

‎docs/classes/QUICServer.html‎

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

‎docs/classes/QUICSocket.html‎

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

‎docs/classes/QUICStream.html‎

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

‎docs/classes/errors.ErrorQUICClient.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ <h4>Hierarchy</h4>
3333
<li><a href="errors.ErrorQUICClientSocketNotRunning.html" class="tsd-signature-type" data-tsd-kind="Class">ErrorQUICClientSocketNotRunning</a></li>
3434
<li><a href="errors.ErrorQUICClientInvalidHost.html" class="tsd-signature-type" data-tsd-kind="Class">ErrorQUICClientInvalidHost</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources">
3535
<ul>
36-
<li>Defined in <a href="https://github.com/MatrixAI/js-quic/blob/master/src/errors.ts#L53">src/errors.ts:53</a></li></ul></aside>
36+
<li>Defined in <a href="https://github.com/MatrixAI/js-quic/blob/master/src/errors.ts#L61">src/errors.ts:61</a></li></ul></aside>
3737
<section class="tsd-panel-group tsd-index-group">
3838
<section class="tsd-panel tsd-index-panel">
3939
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -146,7 +146,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <s
146146
<div class="tsd-signature">description<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">
147147
<p>Overrides <a href="errors.ErrorQUIC.html">ErrorQUIC</a>.<a href="errors.ErrorQUIC.html#description">description</a></p>
148148
<ul>
149-
<li>Defined in <a href="https://github.com/MatrixAI/js-quic/blob/master/src/errors.ts#L54">src/errors.ts:54</a></li></ul></aside></section>
149+
<li>Defined in <a href="https://github.com/MatrixAI/js-quic/blob/master/src/errors.ts#L62">src/errors.ts:62</a></li></ul></aside></section>
150150
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a>
151151
<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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
152152
<div class="tsd-signature">prepare<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</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>

‎docs/classes/errors.ErrorQUICClientCreateTimeOut.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ <h4>Hierarchy</h4>
2828
<ul class="tsd-hierarchy">
2929
<li><span class="target">ErrorQUICClientCreateTimeOut</span></li></ul></li></ul></section><aside class="tsd-sources">
3030
<ul>
31-
<li>Defined in <a href="https://github.com/MatrixAI/js-quic/blob/master/src/errors.ts#L57">src/errors.ts:57</a></li></ul></aside>
31+
<li>Defined in <a href="https://github.com/MatrixAI/js-quic/blob/master/src/errors.ts#L65">src/errors.ts:65</a></li></ul></aside>
3232
<section class="tsd-panel-group tsd-index-group">
3333
<section class="tsd-panel tsd-index-panel">
3434
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -141,7 +141,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <s
141141
<div class="tsd-signature">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;QUICC Client create timeout&#39;</span></div><aside class="tsd-sources">
142142
<p>Overrides <a href="errors.ErrorQUICClient.html">ErrorQUICClient</a>.<a href="errors.ErrorQUICClient.html#description">description</a></p>
143143
<ul>
144-
<li>Defined in <a href="https://github.com/MatrixAI/js-quic/blob/master/src/errors.ts#L58">src/errors.ts:58</a></li></ul></aside></section>
144+
<li>Defined in <a href="https://github.com/MatrixAI/js-quic/blob/master/src/errors.ts#L66">src/errors.ts:66</a></li></ul></aside></section>
145145
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a>
146146
<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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
147147
<div class="tsd-signature">prepare<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</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>

‎docs/classes/errors.ErrorQUICClientDestroyed.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ <h4>Hierarchy</h4>
2828
<ul class="tsd-hierarchy">
2929
<li><span class="target">ErrorQUICClientDestroyed</span></li></ul></li></ul></section><aside class="tsd-sources">
3030
<ul>
31-
<li>Defined in <a href="https://github.com/MatrixAI/js-quic/blob/master/src/errors.ts#L61">src/errors.ts:61</a></li></ul></aside>
31+
<li>Defined in <a href="https://github.com/MatrixAI/js-quic/blob/master/src/errors.ts#L69">src/errors.ts:69</a></li></ul></aside>
3232
<section class="tsd-panel-group tsd-index-group">
3333
<section class="tsd-panel tsd-index-panel">
3434
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -141,7 +141,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <s
141141
<div class="tsd-signature">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;QUIC Client is destroyed&#39;</span></div><aside class="tsd-sources">
142142
<p>Overrides <a href="errors.ErrorQUICClient.html">ErrorQUICClient</a>.<a href="errors.ErrorQUICClient.html#description">description</a></p>
143143
<ul>
144-
<li>Defined in <a href="https://github.com/MatrixAI/js-quic/blob/master/src/errors.ts#L62">src/errors.ts:62</a></li></ul></aside></section>
144+
<li>Defined in <a href="https://github.com/MatrixAI/js-quic/blob/master/src/errors.ts#L70">src/errors.ts:70</a></li></ul></aside></section>
145145
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a>
146146
<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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
147147
<div class="tsd-signature">prepare<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</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>

‎docs/classes/errors.ErrorQUICClientInvalidHost.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ <h4>Hierarchy</h4>
2828
<ul class="tsd-hierarchy">
2929
<li><span class="target">ErrorQUICClientInvalidHost</span></li></ul></li></ul></section><aside class="tsd-sources">
3030
<ul>
31-
<li>Defined in <a href="https://github.com/MatrixAI/js-quic/blob/master/src/errors.ts#L70">src/errors.ts:70</a></li></ul></aside>
31+
<li>Defined in <a href="https://github.com/MatrixAI/js-quic/blob/master/src/errors.ts#L78">src/errors.ts:78</a></li></ul></aside>
3232
<section class="tsd-panel-group tsd-index-group">
3333
<section class="tsd-panel tsd-index-panel">
3434
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -141,7 +141,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <s
141141
<div class="tsd-signature">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;QUIC Client cannot be created with the specified host&#39;</span></div><aside class="tsd-sources">
142142
<p>Overrides <a href="errors.ErrorQUICClient.html">ErrorQUICClient</a>.<a href="errors.ErrorQUICClient.html#description">description</a></p>
143143
<ul>
144-
<li>Defined in <a href="https://github.com/MatrixAI/js-quic/blob/master/src/errors.ts#L71">src/errors.ts:71</a></li></ul></aside></section>
144+
<li>Defined in <a href="https://github.com/MatrixAI/js-quic/blob/master/src/errors.ts#L79">src/errors.ts:79</a></li></ul></aside></section>
145145
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a>
146146
<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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
147147
<div class="tsd-signature">prepare<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</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>

0 commit comments

Comments
 (0)