e2m/uWebSockets.js
3
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update generated TypeDocs

Browse Source
This commit is contained in:
Alex Hultman 2020-05-20 20:23:46 +02:00
parent be45fb6e84
commit 550c49d302
9 changed files with 146 additions and 163 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/generated/assets/js/search.js vendored
View File

File diff suppressed because one or more lines are too long

67
docs/generated/index.html
View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>uWebSockets.js v17.3.0 documentation</title>
<title>uWebSockets.js v17.6.0 documentation</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">uWebSockets.js v17.3.0 documentation</a>
<a href="index.html" class="title">uWebSockets.js v17.6.0 documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -54,7 +54,7 @@
<a href="index.html">Globals</a>
</li>
</ul>
<h1> uWebSockets.js v17.3.0 documentation</h1>
<h1> uWebSockets.js v17.6.0 documentation</h1>
</div>
</div>
</header>
@ -87,7 +87,6 @@
<section class="tsd-index-section ">
<h3>Variables</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-variable"><a href="index.html#dedicated_compressor" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR</a></li>
<li class="tsd-kind-variable"><a href="index.html#dedicated_compressor_128kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>128KB</a></li>
<li class="tsd-kind-variable"><a href="index.html#dedicated_compressor_16kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>16KB</a></li>
<li class="tsd-kind-variable"><a href="index.html#dedicated_compressor_256kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>256KB</a></li>
@ -119,7 +118,7 @@
<div class="tsd-signature tsd-kind-icon">Compress<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L200">index.d.ts:200</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L241">index.d.ts:241</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -134,40 +133,26 @@
<div class="tsd-signature tsd-kind-icon">Recognized<wbr>String<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Int8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint16Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Int16Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint32Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Int32Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float64Array</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L9">index.d.ts:9</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L11">index.d.ts:11</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Recognized string types, things C++ can read and understand as strings</p>
<p>Recognized string types, things C++ can read and understand as strings.
&quot;String&quot; does not have to mean &quot;text&quot;, it can also be &quot;binary&quot;.</p>
</div>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Variables</h2>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="dedicated_compressor" class="tsd-anchor"></a>
<h3>DEDICATED_<wbr>COMPRESSOR</h3>
<div class="tsd-signature tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR<span class="tsd-signature-symbol">:</span> <a href="index.html#compressoptions" class="tsd-signature-type">CompressOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L206">index.d.ts:206</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Sliding dedicated compress window, requires 256KB of memory per socket</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="dedicated_compressor_128kb" class="tsd-anchor"></a>
<h3>DEDICATED_<wbr>COMPRESSOR_<wbr>128KB</h3>
<div class="tsd-signature tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>128KB<span class="tsd-signature-symbol">:</span> <a href="index.html#compressoptions" class="tsd-signature-type">CompressOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L221">index.d.ts:221</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L259">index.d.ts:259</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -182,7 +167,7 @@
<div class="tsd-signature tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>16KB<span class="tsd-signature-symbol">:</span> <a href="index.html#compressoptions" class="tsd-signature-type">CompressOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L215">index.d.ts:215</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L253">index.d.ts:253</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -197,7 +182,7 @@
<div class="tsd-signature tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>256KB<span class="tsd-signature-symbol">:</span> <a href="index.html#compressoptions" class="tsd-signature-type">CompressOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L223">index.d.ts:223</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L261">index.d.ts:261</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -212,7 +197,7 @@
<div class="tsd-signature tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>32KB<span class="tsd-signature-symbol">:</span> <a href="index.html#compressoptions" class="tsd-signature-type">CompressOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L217">index.d.ts:217</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L255">index.d.ts:255</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -227,7 +212,7 @@
<div class="tsd-signature tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>3KB<span class="tsd-signature-symbol">:</span> <a href="index.html#compressoptions" class="tsd-signature-type">CompressOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L209">index.d.ts:209</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L247">index.d.ts:247</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -242,7 +227,7 @@
<div class="tsd-signature tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>4KB<span class="tsd-signature-symbol">:</span> <a href="index.html#compressoptions" class="tsd-signature-type">CompressOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L211">index.d.ts:211</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L249">index.d.ts:249</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -257,7 +242,7 @@
<div class="tsd-signature tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>64KB<span class="tsd-signature-symbol">:</span> <a href="index.html#compressoptions" class="tsd-signature-type">CompressOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L219">index.d.ts:219</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L257">index.d.ts:257</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -272,7 +257,7 @@
<div class="tsd-signature tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>8KB<span class="tsd-signature-symbol">:</span> <a href="index.html#compressoptions" class="tsd-signature-type">CompressOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L213">index.d.ts:213</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L251">index.d.ts:251</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -287,12 +272,12 @@
<div class="tsd-signature tsd-kind-icon">DISABLED<span class="tsd-signature-symbol">:</span> <a href="index.html#compressoptions" class="tsd-signature-type">CompressOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L202">index.d.ts:202</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L243">index.d.ts:243</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>No compression (always a good idea)</p>
<p>No compression (always a good idea if you operate using an efficient binary protocol)</p>
</div>
</div>
</section>
@ -302,12 +287,12 @@
<div class="tsd-signature tsd-kind-icon">SHARED_<wbr>COMPRESSOR<span class="tsd-signature-symbol">:</span> <a href="index.html#compressoptions" class="tsd-signature-type">CompressOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L204">index.d.ts:204</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L245">index.d.ts:245</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Zero memory overhead compression (recommended)</p>
<p>Zero memory overhead compression (recommended for pub/sub where same message is sent to many receivers)</p>
</div>
</div>
</section>
@ -324,12 +309,13 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L191">index.d.ts:191</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L232">index.d.ts:232</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Constructs a non-SSL app</p>
<p>Constructs a non-SSL app. An app is your starting point where you attach behavior to URL routes.
This is also where you listen and run your app, set any SSL options (in case of SSLApp) and the like.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -352,12 +338,12 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L194">index.d.ts:194</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L235">index.d.ts:235</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Constructs an SSL app</p>
<p>Constructs an SSL app. See App.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -380,7 +366,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L197">index.d.ts:197</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L238">index.d.ts:238</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -437,9 +423,6 @@
<li class=" tsd-kind-type-alias">
<a href="index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
</li>
<li class=" tsd-kind-variable">
<a href="index.html#dedicated_compressor" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR</a>
</li>
<li class=" tsd-kind-variable">
<a href="index.html#dedicated_compressor_128kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>128KB</a>
</li>

20
docs/generated/interfaces/appoptions.html
View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AppOptions | uWebSockets.js v17.3.0 documentation</title>
<title>AppOptions | uWebSockets.js v17.6.0 documentation</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">uWebSockets.js v17.3.0 documentation</a>
<a href="../index.html" class="title">uWebSockets.js v17.6.0 documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -67,7 +67,8 @@
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Options used when constructing an app.</p>
<p>Options used when constructing an app. Especially for SSLApp.
These are options passed directly to uSockets, C layer.</p>
</div>
</div>
</section>
@ -104,7 +105,7 @@
<div class="tsd-signature tsd-kind-icon">cert_<wbr>file_<wbr>name<span class="tsd-signature-symbol">:</span> <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L151">index.d.ts:151</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L190">index.d.ts:190</a></li>
</ul>
</aside>
</section>
@ -114,7 +115,7 @@
<div class="tsd-signature tsd-kind-icon">dh_<wbr>params_<wbr>file_<wbr>name<span class="tsd-signature-symbol">:</span> <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L153">index.d.ts:153</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L192">index.d.ts:192</a></li>
</ul>
</aside>
</section>
@ -124,7 +125,7 @@
<div class="tsd-signature tsd-kind-icon">key_<wbr>file_<wbr>name<span class="tsd-signature-symbol">:</span> <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L150">index.d.ts:150</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L189">index.d.ts:189</a></li>
</ul>
</aside>
</section>
@ -134,7 +135,7 @@
<div class="tsd-signature tsd-kind-icon">passphrase<span class="tsd-signature-symbol">:</span> <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L152">index.d.ts:152</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L191">index.d.ts:191</a></li>
</ul>
</aside>
</section>
@ -144,7 +145,7 @@
<div class="tsd-signature tsd-kind-icon">ssl_<wbr>prefer_<wbr>low_<wbr>memory_<wbr>usage<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L155">index.d.ts:155</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L194">index.d.ts:194</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -213,9 +214,6 @@
<li class=" tsd-kind-type-alias">
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
</li>
<li class=" tsd-kind-variable">
<a href="../index.html#dedicated_compressor" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR</a>
</li>
<li class=" tsd-kind-variable">
<a href="../index.html#dedicated_compressor_128kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>128KB</a>
</li>

21
docs/generated/interfaces/httprequest.html
View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>HttpRequest | uWebSockets.js v17.3.0 documentation</title>
<title>HttpRequest | uWebSockets.js v17.6.0 documentation</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">uWebSockets.js v17.3.0 documentation</a>
<a href="../index.html" class="title">uWebSockets.js v17.6.0 documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -110,7 +110,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L119">index.d.ts:119</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L152">index.d.ts:152</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -159,7 +159,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L109">index.d.ts:109</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L142">index.d.ts:142</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -187,7 +187,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L115">index.d.ts:115</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L148">index.d.ts:148</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -209,7 +209,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L111">index.d.ts:111</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L144">index.d.ts:144</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -237,7 +237,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L117">index.d.ts:117</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L150">index.d.ts:150</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -259,7 +259,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L113">index.d.ts:113</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L146">index.d.ts:146</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -281,7 +281,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L121">index.d.ts:121</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L154">index.d.ts:154</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -365,9 +365,6 @@
<li class=" tsd-kind-type-alias">
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
</li>
<li class=" tsd-kind-variable">
<a href="../index.html#dedicated_compressor" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR</a>
</li>
<li class=" tsd-kind-variable">
<a href="../index.html#dedicated_compressor_128kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>128KB</a>
</li>

31
docs/generated/interfaces/httpresponse.html
View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>HttpResponse | uWebSockets.js v17.3.0 documentation</title>
<title>HttpResponse | uWebSockets.js v17.6.0 documentation</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">uWebSockets.js v17.3.0 documentation</a>
<a href="../index.html" class="title">uWebSockets.js v17.6.0 documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -124,7 +124,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L64">index.d.ts:64</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L97">index.d.ts:97</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -146,7 +146,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L100">index.d.ts:100</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L133">index.d.ts:133</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -195,7 +195,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L59">index.d.ts:59</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L92">index.d.ts:92</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -223,7 +223,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L85">index.d.ts:85</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L118">index.d.ts:118</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -245,7 +245,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L67">index.d.ts:67</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L100">index.d.ts:100</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -267,7 +267,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L79">index.d.ts:79</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L112">index.d.ts:112</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -310,7 +310,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L82">index.d.ts:82</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L115">index.d.ts:115</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -359,7 +359,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L73">index.d.ts:73</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L106">index.d.ts:106</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -407,7 +407,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L61">index.d.ts:61</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L94">index.d.ts:94</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -438,7 +438,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L57">index.d.ts:57</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L90">index.d.ts:90</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -466,7 +466,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L55">index.d.ts:55</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L88">index.d.ts:88</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -497,7 +497,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L53">index.d.ts:53</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L86">index.d.ts:86</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -596,9 +596,6 @@
<li class=" tsd-kind-type-alias">
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
</li>
<li class=" tsd-kind-variable">
<a href="../index.html#dedicated_compressor" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR</a>
</li>
<li class=" tsd-kind-variable">
<a href="../index.html#dedicated_compressor_128kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>128KB</a>
</li>

37
docs/generated/interfaces/templatedapp.html
View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>TemplatedApp | uWebSockets.js v17.3.0 documentation</title>
<title>TemplatedApp | uWebSockets.js v17.6.0 documentation</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">uWebSockets.js v17.3.0 documentation</a>
<a href="../index.html" class="title">uWebSockets.js v17.6.0 documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -67,7 +67,7 @@
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>TemplatedApp is either an SSL or non-SSL app.</p>
<p>TemplatedApp is either an SSL or non-SSL app. See App for more info, read user manual.</p>
</div>
</div>
</section>
@ -116,7 +116,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L183">index.d.ts:183</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L222">index.d.ts:222</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -168,7 +168,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L179">index.d.ts:179</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L218">index.d.ts:218</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -220,7 +220,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L171">index.d.ts:171</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L210">index.d.ts:210</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -272,7 +272,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L165">index.d.ts:165</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L204">index.d.ts:204</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -324,7 +324,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L177">index.d.ts:177</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L216">index.d.ts:216</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -377,7 +377,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L161">index.d.ts:161</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L200">index.d.ts:200</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -420,7 +420,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L163">index.d.ts:163</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L202">index.d.ts:202</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -469,7 +469,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L169">index.d.ts:169</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L208">index.d.ts:208</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -521,7 +521,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L173">index.d.ts:173</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L212">index.d.ts:212</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -573,7 +573,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L167">index.d.ts:167</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L206">index.d.ts:206</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -625,7 +625,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L187">index.d.ts:187</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L226">index.d.ts:226</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -662,7 +662,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L175">index.d.ts:175</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L214">index.d.ts:214</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -714,7 +714,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L181">index.d.ts:181</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L220">index.d.ts:220</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -766,7 +766,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L185">index.d.ts:185</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L224">index.d.ts:224</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -871,9 +871,6 @@
<li class=" tsd-kind-type-alias">
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
</li>
<li class=" tsd-kind-variable">
<a href="../index.html#dedicated_compressor" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR</a>
</li>
<li class=" tsd-kind-variable">
<a href="../index.html#dedicated_compressor_128kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>128KB</a>
</li>

10
docs/generated/interfaces/us_listen_socket.html
View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>us_listen_socket | uWebSockets.js v17.3.0 documentation</title>
<title>us_listen_socket | uWebSockets.js v17.6.0 documentation</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">uWebSockets.js v17.3.0 documentation</a>
<a href="../index.html" class="title">uWebSockets.js v17.6.0 documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -67,7 +67,8 @@
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Native type representing a raw uSockets struct us_listen_socket.</p>
<p>Native type representing a raw uSockets struct us_listen_socket.
Careful with this one, it is entirely unchecked and native so invalid usage will blow up.</p>
</div>
</div>
</section>
@ -121,9 +122,6 @@
<li class=" tsd-kind-type-alias">
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
</li>
<li class=" tsd-kind-variable">
<a href="../index.html#dedicated_compressor" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR</a>
</li>
<li class=" tsd-kind-variable">
<a href="../index.html#dedicated_compressor_128kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>128KB</a>
</li>

72
docs/generated/interfaces/websocket.html
View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>WebSocket | uWebSockets.js v17.3.0 documentation</title>
<title>WebSocket | uWebSockets.js v17.6.0 documentation</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">uWebSockets.js v17.3.0 documentation</a>
<a href="../index.html" class="title">uWebSockets.js v17.6.0 documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -67,7 +67,8 @@
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A WebSocket connection that is valid from open to close event</p>
<p>A WebSocket connection that is valid from open to close event.
Read more about this in the user manual.</p>
</div>
</div>
</section>
@ -84,7 +85,7 @@
<div class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></div>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Arbitrary user data may be attached to this object</p>
<p>Arbitrary user data may be attached to this object. In C++ this is done by using getUserData().</p>
</div>
</div>
</section>
@ -123,12 +124,13 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L23">index.d.ts:23</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L37">index.d.ts:37</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Forcefully closes this WebSocket</p>
<p>Forcefully closes this WebSocket. Immediately calls the close handler.
No WebSocket close message is sent.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="websocket.html" class="tsd-signature-type">WebSocket</a></h4>
@ -145,12 +147,12 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L41">index.d.ts:41</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L68">index.d.ts:68</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>See HttpResponse.cork</p>
<p>See HttpResponse.cork. Takes a function in which the socket is corked (packing many sends into one single syscall/SSL block)</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -185,12 +187,13 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L20">index.d.ts:20</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L32">index.d.ts:32</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Gracefully closes this WebSocket. Immediately calls close handler.</p>
<p>Gracefully closes this WebSocket. Immediately calls the close handler.
A WebSocket close message is sent with code and shortMessage.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -216,12 +219,13 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L17">index.d.ts:17</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L27">index.d.ts:27</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the bytes buffered in backpressure.</p>
<p>Returns the bytes buffered in backpressure. This is similar to the bufferedAmount property in the browser counterpart.
Check backpressure example.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
@ -238,13 +242,16 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L44">index.d.ts:44</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L77">index.d.ts:77</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the remote IP address</p>
<p>Returns the remote IP address. Note that the returned IP is binary, not text.</p>
</div>
<p>IPv4 is 4 byte long and can be converted to text by printing every byte as a digit between 0 and 255.
IPv6 is 16 byte long and can be converted to text in similar ways, but you typically print digits in HEX.</p>
<p>We will probably add a text converting function at some point as this is a common issue among users.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ArrayBuffer</span></h4>
</li>
@ -260,12 +267,12 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L26">index.d.ts:26</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L40">index.d.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Sends a ping control message. Returns true on success, see WebSocket.send. This helper function correlates to WebSocket::send(message, uWS::OpCode::PING, ...).</p>
<p>Sends a ping control message. Returns true on success in similar ways as WebSocket.send does (regarding backpressure). This helper function correlates to WebSocket::send(message, uWS::OpCode::PING, ...) in C++.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -288,13 +295,19 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L38">index.d.ts:38</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L65">index.d.ts:65</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Publish a message to a topic in MQTT syntax</p>
<p>Publish a message to a topic in MQTT syntax. You cannot publish using wildcards, only fully specified topics. Just like with MQTT.</p>
</div>
<p>&quot;parent/child&quot; kind of tree is allowed, but not &quot;parent/#&quot; kind of wildcard publishing.</p>
<p>NOTE: publish is NOT immediately active, the actual publish takes place at the end of the current event loop iteration.
This to efficiently pack and batch outgoing publishes, and to coalesce outgoing messages across multiple topics.
Publishing to many different topics, or to the same topic many times, will thus be properly coalesced into one single send syscall and one single SSL block, per socket.</p>
<p>This also means that publishing to a topic, then immediately subscribing to it in the same very event loop iteration will cause that publish to also affect the late subscription.
Think of it as - subscription vs. publish happens in terms of event loop iterations. If you REQUIRE a strict ordering you have to use Loop::defer or process.nextTick accordingly.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
@ -325,13 +338,15 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L14">index.d.ts:14</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L22">index.d.ts:22</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Sends a message. Make sure to check getBufferedAmount() before sending. Returns true for success, false for built up backpressure that will drain when time is given.</p>
<p>Sends a message. Make sure to check getBufferedAmount() before sending. Returns true for success, false for built up backpressure that will drain when time is given.
Returning false does not mean nothing was sent, it only means backpressure was built up. This you can check by calling getBufferedAmount() afterwards.</p>
</div>
<p>Make sure you properly understand the contept of backpressure. Check the backpressure example file.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
@ -359,12 +374,14 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L29">index.d.ts:29</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L46">index.d.ts:46</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Subscribe to a topic in MQTT syntax</p>
<p>Subscribe to a topic in MQTT syntax. Subscription is immediately active.
MQTT syntax includes things like &quot;root/child/+/grandchild&quot; where &quot;+&quot; is a
wildcard and &quot;root/#&quot; where &quot;#&quot; is a terminating wildcard.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -387,12 +404,12 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L32">index.d.ts:32</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L49">index.d.ts:49</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Unsubscribe from a topic. Returns true on success, if the WebSocket was subscribed.</p>
<p>Unsubscribe from a topic. Returns true on success, if the WebSocket was subscribed. Unsubscription is immediately active.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -415,12 +432,12 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L35">index.d.ts:35</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L52">index.d.ts:52</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Unsubscribe from all topics.</p>
<p>Unsubscribe from all topics. Immediately active. This is called automatically before any close handler is called, so you never need to call this manually in the close handler of a WebSocket.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
@ -505,9 +522,6 @@
<li class=" tsd-kind-type-alias">
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
</li>
<li class=" tsd-kind-variable">
<a href="../index.html#dedicated_compressor" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR</a>
</li>
<li class=" tsd-kind-variable">
<a href="../index.html#dedicated_compressor_128kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>128KB</a>
</li>

49
docs/generated/interfaces/websocketbehavior.html
View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>WebSocketBehavior | uWebSockets.js v17.3.0 documentation</title>
<title>WebSocketBehavior | uWebSockets.js v17.6.0 documentation</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">uWebSockets.js v17.3.0 documentation</a>
<a href="../index.html" class="title">uWebSockets.js v17.6.0 documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -67,7 +67,7 @@
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A structure holding settings and handlers for a WebSocket route handler.</p>
<p>A structure holding settings and handlers for a WebSocket URL route handler.</p>
</div>
</div>
</section>
@ -109,12 +109,12 @@
<div class="tsd-signature tsd-kind-icon">close<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L141">index.d.ts:141</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L178">index.d.ts:178</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Handler for close event, no matter if error, timeout or graceful close. You may not use WebSocket after this event.</p>
<p>Handler for close event, no matter if error, timeout or graceful close. You may not use WebSocket after this event. Do not send on this WebSocket from within here, it is closed.</p>
</div>
</div>
<div class="tsd-type-declaration">
@ -151,12 +151,12 @@
<div class="tsd-signature tsd-kind-icon">compression<span class="tsd-signature-symbol">:</span> <a href="../index.html#compressoptions" class="tsd-signature-type">CompressOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L131">index.d.ts:131</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L166">index.d.ts:166</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>0 = no compression, 1 = shared compressor, 2 = dedicated compressor. See C++ project.</p>
<p>What permessage-deflate compression to use. uWS.DISABLED, uWS.SHARED_COMPRESSOR or any of the uWS.DEDICATED_COMPRESSOR_xxxKB.</p>
</div>
</div>
</section>
@ -166,12 +166,12 @@
<div class="tsd-signature tsd-kind-icon">drain<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L139">index.d.ts:139</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L176">index.d.ts:176</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Handler for when WebSocket backpressure drains. Check ws.getBufferedAmount().</p>
<p>Handler for when WebSocket backpressure drains. Check ws.getBufferedAmount(). Use this to guide / drive your backpressure throttling.</p>
</div>
</div>
<div class="tsd-type-declaration">
@ -202,12 +202,13 @@
<div class="tsd-signature tsd-kind-icon">idle<wbr>Timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L129">index.d.ts:129</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L164">index.d.ts:164</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Maximum amount of seconds that may pass without sending or getting a message.</p>
<p>Maximum amount of seconds that may pass without sending or getting a message. Connection is closed if this timeout passes. Resolution (granularity) for timeouts are typically 4 seconds, rounded to closest.
Disable by leaving 0.</p>
</div>
</div>
</section>
@ -217,12 +218,12 @@
<div class="tsd-signature tsd-kind-icon">max<wbr>Backpressure<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L133">index.d.ts:133</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L168">index.d.ts:168</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Maximum length of allowed backpressure per socket when publishing messages. Slow receivers, WebSockets, will be disconnected if needed.</p>
<p>Maximum length of allowed backpressure per socket when PUBLISHING messages (does not apply to ws.send). Slow receivers with too high backpressure will be skipped until they catch up or timeout.</p>
</div>
</div>
</section>
@ -232,12 +233,12 @@
<div class="tsd-signature tsd-kind-icon">max<wbr>Payload<wbr>Length<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L127">index.d.ts:127</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L160">index.d.ts:160</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Maximum length of received message.</p>
<p>Maximum length of received message. If a client tries to send you a message larger than this, the connection is immediately closed.</p>
</div>
</div>
</section>
@ -247,12 +248,12 @@
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L137">index.d.ts:137</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L174">index.d.ts:174</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Handler for a WebSocket message.</p>
<p>Handler for a WebSocket message. Messages are given as ArrayBuffer no matter if they are binary or not. Given ArrayBuffer is valid during the lifetime of this callback (until first await or return) and will be neutered.</p>
</div>
</div>
<div class="tsd-type-declaration">
@ -289,12 +290,13 @@
<div class="tsd-signature tsd-kind-icon">open<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L135">index.d.ts:135</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L172">index.d.ts:172</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Handler for new WebSocket connection. WebSocket is valid from open to close, no errors.</p>
<p>Handler for new WebSocket connection. WebSocket is valid from open to close, no errors.
You may access the HttpRequest during the lifetime of the callback (until first await or return).</p>
</div>
</div>
<div class="tsd-type-declaration">
@ -328,12 +330,12 @@
<div class="tsd-signature tsd-kind-icon">ping<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L143">index.d.ts:143</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L180">index.d.ts:180</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Handler for received ping control message.</p>
<p>Handler for received ping control message. You do not need to handle this, pong messages are automatically sent as per the standard.</p>
</div>
</div>
<div class="tsd-type-declaration">
@ -364,7 +366,7 @@
<div class="tsd-signature tsd-kind-icon">pong<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f9c3cf4/docs/index.d.ts#L145">index.d.ts:145</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L182">index.d.ts:182</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -469,9 +471,6 @@
<li class=" tsd-kind-type-alias">
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
</li>
<li class=" tsd-kind-variable">
<a href="../index.html#dedicated_compressor" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR</a>
</li>
<li class=" tsd-kind-variable">
<a href="../index.html#dedicated_compressor_128kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>128KB</a>
</li>