Skip to content

Commit 816e8d0

Browse files
uNetworkingABuNetworkingAB
committed
Update docs
1 parent 271083a commit 816e8d0

34 files changed

+163
-109
lines changed

‎docs/generated/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/generated/enums/ListenOptions.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<li><a href="ListenOptions.html">ListenOptions</a></li></ul>
1717
<h1>Enumeration ListenOptions</h1></div><aside class="tsd-sources">
1818
<ul>
19-
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L273">index.d.ts:273</a></li></ul></aside>
19+
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L275">index.d.ts:275</a></li></ul></aside>
2020
<section class="tsd-panel-group tsd-index-group">
2121
<section class="tsd-panel tsd-index-panel">
2222
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -33,12 +33,12 @@ <h2>Enumeration Members</h2>
3333
<h3 class="tsd-anchor-link"><span>LIBUS_<wbr/>LISTEN_<wbr/>DEFAULT</span><a href="#LIBUS_LISTEN_DEFAULT" 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"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
3434
<div class="tsd-signature">LIBUS_<wbr/>LISTEN_<wbr/>DEFAULT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">0</span></div><aside class="tsd-sources">
3535
<ul>
36-
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L274">index.d.ts:274</a></li></ul></aside></section>
36+
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L276">index.d.ts:276</a></li></ul></aside></section>
3737
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="LIBUS_LISTEN_EXCLUSIVE_PORT" class="tsd-anchor"></a>
3838
<h3 class="tsd-anchor-link"><span>LIBUS_<wbr/>LISTEN_<wbr/>EXCLUSIVE_<wbr/>PORT</span><a href="#LIBUS_LISTEN_EXCLUSIVE_PORT" 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>
3939
<div class="tsd-signature">LIBUS_<wbr/>LISTEN_<wbr/>EXCLUSIVE_<wbr/>PORT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span></div><aside class="tsd-sources">
4040
<ul>
41-
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L275">index.d.ts:275</a></li></ul></aside></section></section></div>
41+
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L277">index.d.ts:277</a></li></ul></aside></section></section></div>
4242
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
4343
<div class="tsd-navigation settings">
4444
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

‎docs/generated/functions/App.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
2929
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../interfaces/AppOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AppOptions</a></h5></li></ul></div>
3030
<h4 class="tsd-returns-title">Returns <a href="../interfaces/TemplatedApp.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplatedApp</a></h4><aside class="tsd-sources">
3131
<ul>
32-
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L323">index.d.ts:323</a></li></ul></aside></li></ul></section></div>
32+
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L325">index.d.ts:325</a></li></ul></aside></li></ul></section></div>
3333
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
3434
<div class="tsd-navigation settings">
3535
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

‎docs/generated/functions/SSLApp.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
2828
<h5>options: <a href="../interfaces/AppOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AppOptions</a></h5></li></ul></div>
2929
<h4 class="tsd-returns-title">Returns <a href="../interfaces/TemplatedApp.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplatedApp</a></h4><aside class="tsd-sources">
3030
<ul>
31-
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L326">index.d.ts:326</a></li></ul></aside></li></ul></section></div>
31+
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L328">index.d.ts:328</a></li></ul></aside></li></ul></section></div>
3232
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
3333
<div class="tsd-navigation settings">
3434
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

‎docs/generated/functions/getParts.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ <h5>body: <a href="../types/RecognizedString.html" class="tsd-signature-type" da
3030
<h5>contentType: <a href="../types/RecognizedString.html" class="tsd-signature-type" data-tsd-kind="Type alias">RecognizedString</a></h5></li></ul></div>
3131
<h4 class="tsd-returns-title">Returns <a href="../interfaces/MultipartField.html" class="tsd-signature-type" data-tsd-kind="Interface">MultipartField</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h4><aside class="tsd-sources">
3232
<ul>
33-
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L342">index.d.ts:342</a></li></ul></aside></li></ul></section></div>
33+
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L344">index.d.ts:344</a></li></ul></aside></li></ul></section></div>
3434
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
3535
<div class="tsd-navigation settings">
3636
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

‎docs/generated/functions/us_listen_socket_close.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
2828
<h5>listenSocket: <a href="../interfaces/us_listen_socket.html" class="tsd-signature-type" data-tsd-kind="Interface">us_listen_socket</a></h5></li></ul></div>
2929
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
3030
<ul>
31-
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L329">index.d.ts:329</a></li></ul></aside></li></ul></section></div>
31+
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L331">index.d.ts:331</a></li></ul></aside></li></ul></section></div>
3232
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
3333
<div class="tsd-navigation settings">
3434
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

‎docs/generated/functions/us_socket_local_port.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
2828
<h5>socket: <a href="../interfaces/us_socket.html" class="tsd-signature-type" data-tsd-kind="Interface">us_socket</a></h5></li></ul></div>
2929
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
3030
<ul>
31-
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L332">index.d.ts:332</a></li></ul></aside></li></ul></section></div>
31+
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L334">index.d.ts:334</a></li></ul></aside></li></ul></section></div>
3232
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
3333
<div class="tsd-navigation settings">
3434
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

‎docs/generated/interfaces/AppOptions.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ <h4>Hierarchy</h4>
2424
<ul class="tsd-hierarchy">
2525
<li><span class="target">AppOptions</span></li></ul></section><aside class="tsd-sources">
2626
<ul>
27-
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L262">index.d.ts:262</a></li></ul></aside>
27+
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L264">index.d.ts:264</a></li></ul></aside>
2828
<section class="tsd-panel-group tsd-index-group">
2929
<section class="tsd-panel tsd-index-panel">
3030
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -46,39 +46,39 @@ <h2>Properties</h2>
4646
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>ca_<wbr/>file_<wbr/>name</span><a href="#ca_file_name" 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"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
4747
<div class="tsd-signature">ca_<wbr/>file_<wbr/>name<span class="tsd-signature-symbol">?:</span> <a href="../types/RecognizedString.html" class="tsd-signature-type" data-tsd-kind="Type alias">RecognizedString</a></div><aside class="tsd-sources">
4848
<ul>
49-
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L265">index.d.ts:265</a></li></ul></aside></section>
49+
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L267">index.d.ts:267</a></li></ul></aside></section>
5050
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="cert_file_name" class="tsd-anchor"></a>
5151
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cert_<wbr/>file_<wbr/>name</span><a href="#cert_file_name" 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>
5252
<div class="tsd-signature">cert_<wbr/>file_<wbr/>name<span class="tsd-signature-symbol">?:</span> <a href="../types/RecognizedString.html" class="tsd-signature-type" data-tsd-kind="Type alias">RecognizedString</a></div><aside class="tsd-sources">
5353
<ul>
54-
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L264">index.d.ts:264</a></li></ul></aside></section>
54+
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L266">index.d.ts:266</a></li></ul></aside></section>
5555
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="dh_params_file_name" class="tsd-anchor"></a>
5656
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>dh_<wbr/>params_<wbr/>file_<wbr/>name</span><a href="#dh_params_file_name" 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>
5757
<div class="tsd-signature">dh_<wbr/>params_<wbr/>file_<wbr/>name<span class="tsd-signature-symbol">?:</span> <a href="../types/RecognizedString.html" class="tsd-signature-type" data-tsd-kind="Type alias">RecognizedString</a></div><aside class="tsd-sources">
5858
<ul>
59-
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L267">index.d.ts:267</a></li></ul></aside></section>
59+
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L269">index.d.ts:269</a></li></ul></aside></section>
6060
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="key_file_name" class="tsd-anchor"></a>
6161
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>key_<wbr/>file_<wbr/>name</span><a href="#key_file_name" 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>
6262
<div class="tsd-signature">key_<wbr/>file_<wbr/>name<span class="tsd-signature-symbol">?:</span> <a href="../types/RecognizedString.html" class="tsd-signature-type" data-tsd-kind="Type alias">RecognizedString</a></div><aside class="tsd-sources">
6363
<ul>
64-
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L263">index.d.ts:263</a></li></ul></aside></section>
64+
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L265">index.d.ts:265</a></li></ul></aside></section>
6565
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="passphrase" class="tsd-anchor"></a>
6666
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>passphrase</span><a href="#passphrase" 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>
6767
<div class="tsd-signature">passphrase<span class="tsd-signature-symbol">?:</span> <a href="../types/RecognizedString.html" class="tsd-signature-type" data-tsd-kind="Type alias">RecognizedString</a></div><aside class="tsd-sources">
6868
<ul>
69-
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L266">index.d.ts:266</a></li></ul></aside></section>
69+
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L268">index.d.ts:268</a></li></ul></aside></section>
7070
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ssl_ciphers" class="tsd-anchor"></a>
7171
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>ssl_<wbr/>ciphers</span><a href="#ssl_ciphers" 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>
7272
<div class="tsd-signature">ssl_<wbr/>ciphers<span class="tsd-signature-symbol">?:</span> <a href="../types/RecognizedString.html" class="tsd-signature-type" data-tsd-kind="Type alias">RecognizedString</a></div><aside class="tsd-sources">
7373
<ul>
74-
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L268">index.d.ts:268</a></li></ul></aside></section>
74+
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L270">index.d.ts:270</a></li></ul></aside></section>
7575
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ssl_prefer_low_memory_usage" class="tsd-anchor"></a>
7676
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>ssl_<wbr/>prefer_<wbr/>low_<wbr/>memory_<wbr/>usage</span><a href="#ssl_prefer_low_memory_usage" 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>
7777
<div class="tsd-signature">ssl_<wbr/>prefer_<wbr/>low_<wbr/>memory_<wbr/>usage<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
7878
<div class="tsd-comment tsd-typography"><p>This translates to SSL_MODE_RELEASE_BUFFERS</p>
7979
</div><aside class="tsd-sources">
8080
<ul>
81-
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L270">index.d.ts:270</a></li></ul></aside></section></section></div>
81+
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L272">index.d.ts:272</a></li></ul></aside></section></section></div>
8282
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
8383
<div class="tsd-navigation settings">
8484
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

0 commit comments

Comments
 (0)