fix typedoc, gen latest docs (#599)

* fix typedoc

* gen docs

* fix version #

Co-authored-by: e3dio <>
This commit is contained in:
e3dio 2021-08-15 17:34:38 -07:00 committed by GitHub
parent 8f5383157d
commit 935ca2cab8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
18 changed files with 1810 additions and 1227 deletions

View file

@ -3,10 +3,11 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>uWebSockets.js v19.0.0 documentation</title>
<meta name="description" content="Documentation for uWebSockets.js v19.0.0 documentation">
<title>uWebSockets.js v19.3.0 documentation</title>
<meta name="description" content="Documentation for uWebSockets.js v19.3.0 documentation">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
<script async src="assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
@ -22,7 +23,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 v19.0.0 documentation</a>
<a href="index.html" class="title">uWebSockets.js v19.3.0 documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -38,8 +39,6 @@
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
@ -49,12 +48,7 @@
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="index.html">Globals</a>
</li>
</ul>
<h1>uWebSockets.js v19.0.0 documentation</h1>
<h1>uWebSockets.js v19.3.0 documentation</h1>
</div>
</div>
</header>
@ -68,52 +62,54 @@
<section class="tsd-index-section ">
<h3>Enumerations</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-enum"><a href="enums/listenoptions.html" class="tsd-kind-icon">Listen<wbr>Options</a></li>
<li class="tsd-kind-enum"><a href="enums/ListenOptions.html" class="tsd-kind-icon">Listen<wbr>Options</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface"><a href="interfaces/appoptions.html" class="tsd-kind-icon">App<wbr>Options</a></li>
<li class="tsd-kind-interface"><a href="interfaces/httprequest.html" class="tsd-kind-icon">Http<wbr>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/httpresponse.html" class="tsd-kind-icon">Http<wbr>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/multipartfield.html" class="tsd-kind-icon">Multipart<wbr>Field</a></li>
<li class="tsd-kind-interface"><a href="interfaces/templatedapp.html" class="tsd-kind-icon">Templated<wbr>App</a></li>
<li class="tsd-kind-interface"><a href="interfaces/websocket.html" class="tsd-kind-icon">Web<wbr>Socket</a></li>
<li class="tsd-kind-interface"><a href="interfaces/websocketbehavior.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Behavior</a></li>
<li class="tsd-kind-interface"><a href="interfaces/AppOptions.html" class="tsd-kind-icon">App<wbr>Options</a></li>
<li class="tsd-kind-interface"><a href="interfaces/HttpRequest.html" class="tsd-kind-icon">Http<wbr>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/HttpResponse.html" class="tsd-kind-icon">Http<wbr>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/MultipartField.html" class="tsd-kind-icon">Multipart<wbr>Field</a></li>
<li class="tsd-kind-interface"><a href="interfaces/TemplatedApp.html" class="tsd-kind-icon">Templated<wbr>App</a></li>
<li class="tsd-kind-interface"><a href="interfaces/WebSocket.html" class="tsd-kind-icon">Web<wbr>Socket</a></li>
<li class="tsd-kind-interface"><a href="interfaces/WebSocketBehavior.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Behavior</a></li>
<li class="tsd-kind-interface"><a href="interfaces/us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a></li>
<li class="tsd-kind-interface"><a href="interfaces/us_socket.html" class="tsd-kind-icon">us_<wbr>socket</a></li>
<li class="tsd-kind-interface"><a href="interfaces/us_socket_context_t.html" class="tsd-kind-icon">us_<wbr>socket_<wbr>context_<wbr>t</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Type aliases</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-type-alias"><a href="index.html#compressoptions" class="tsd-kind-icon">Compress<wbr>Options</a></li>
<li class="tsd-kind-type-alias"><a href="index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a></li>
<li class="tsd-kind-type-alias"><a href="index.html#CompressOptions" class="tsd-kind-icon">Compress<wbr>Options</a></li>
<li class="tsd-kind-type-alias"><a href="index.html#RecognizedString" class="tsd-kind-icon">Recognized<wbr>String</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Variables</h3>
<ul class="tsd-index-list">
<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>
<li class="tsd-kind-variable"><a href="index.html#dedicated_compressor_32kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>32KB</a></li>
<li class="tsd-kind-variable"><a href="index.html#dedicated_compressor_3kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>3KB</a></li>
<li class="tsd-kind-variable"><a href="index.html#dedicated_compressor_4kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>4KB</a></li>
<li class="tsd-kind-variable"><a href="index.html#dedicated_compressor_64kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>64KB</a></li>
<li class="tsd-kind-variable"><a href="index.html#dedicated_compressor_8kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>8KB</a></li>
<li class="tsd-kind-variable"><a href="index.html#disabled" class="tsd-kind-icon">DISABLED</a></li>
<li class="tsd-kind-variable"><a href="index.html#shared_compressor" class="tsd-kind-icon">SHARED_<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>
<li class="tsd-kind-variable"><a href="index.html#DEDICATED_COMPRESSOR_32KB" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>32KB</a></li>
<li class="tsd-kind-variable"><a href="index.html#DEDICATED_COMPRESSOR_3KB" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>3KB</a></li>
<li class="tsd-kind-variable"><a href="index.html#DEDICATED_COMPRESSOR_4KB" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>4KB</a></li>
<li class="tsd-kind-variable"><a href="index.html#DEDICATED_COMPRESSOR_64KB" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>64KB</a></li>
<li class="tsd-kind-variable"><a href="index.html#DEDICATED_COMPRESSOR_8KB" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>8KB</a></li>
<li class="tsd-kind-variable"><a href="index.html#DISABLED" class="tsd-kind-icon">DISABLED</a></li>
<li class="tsd-kind-variable"><a href="index.html#SHARED_COMPRESSOR" class="tsd-kind-icon">SHARED_<wbr>COMPRESSOR</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function"><a href="index.html#app" class="tsd-kind-icon">App</a></li>
<li class="tsd-kind-function"><a href="index.html#sslapp" class="tsd-kind-icon">SSLApp</a></li>
<li class="tsd-kind-function"><a href="index.html#getparts" class="tsd-kind-icon">get<wbr>Parts</a></li>
<li class="tsd-kind-function"><a href="index.html#App" class="tsd-kind-icon">App</a></li>
<li class="tsd-kind-function"><a href="index.html#SSLApp" class="tsd-kind-icon">SSLApp</a></li>
<li class="tsd-kind-function"><a href="index.html#getParts" class="tsd-kind-icon">get<wbr>Parts</a></li>
<li class="tsd-kind-function"><a href="index.html#us_listen_socket_close" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket_<wbr>close</a></li>
<li class="tsd-kind-function"><a href="index.html#us_socket_local_port" class="tsd-kind-icon">us_<wbr>socket_<wbr>local_<wbr>port</a></li>
</ul>
</section>
</div>
@ -122,12 +118,12 @@
<section class="tsd-panel-group tsd-member-group ">
<h2>Type aliases</h2>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="compressoptions" class="tsd-anchor"></a>
<a name="CompressOptions" class="tsd-anchor"></a>
<h3>Compress<wbr>Options</h3>
<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/f246c24/docs/index.d.ts#L326">index.d.ts:326</a></li>
<li>Defined in <a href="https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L342">index.d.ts:342</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -137,12 +133,12 @@
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="recognizedstring" class="tsd-anchor"></a>
<a name="RecognizedString" class="tsd-anchor"></a>
<h3>Recognized<wbr>String</h3>
<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/f246c24/docs/index.d.ts#L38">index.d.ts:38</a></li>
<li>Defined in <a href="https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L45">index.d.ts:45</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -160,12 +156,12 @@
<section class="tsd-panel-group tsd-member-group ">
<h2>Variables</h2>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="dedicated_compressor_128kb" class="tsd-anchor"></a>
<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>
<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" data-tsd-kind="Type alias">CompressOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L344">index.d.ts:344</a></li>
<li>Defined in <a href="https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L360">index.d.ts:360</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -175,12 +171,12 @@
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="dedicated_compressor_16kb" class="tsd-anchor"></a>
<a name="DEDICATED_COMPRESSOR_16KB" class="tsd-anchor"></a>
<h3>DEDICATED_<wbr>COMPRESSOR_<wbr>16KB</h3>
<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>
<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" data-tsd-kind="Type alias">CompressOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L338">index.d.ts:338</a></li>
<li>Defined in <a href="https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L354">index.d.ts:354</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -190,12 +186,12 @@
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="dedicated_compressor_256kb" class="tsd-anchor"></a>
<a name="DEDICATED_COMPRESSOR_256KB" class="tsd-anchor"></a>
<h3>DEDICATED_<wbr>COMPRESSOR_<wbr>256KB</h3>
<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>
<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" data-tsd-kind="Type alias">CompressOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L346">index.d.ts:346</a></li>
<li>Defined in <a href="https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L362">index.d.ts:362</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -205,12 +201,12 @@
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="dedicated_compressor_32kb" class="tsd-anchor"></a>
<a name="DEDICATED_COMPRESSOR_32KB" class="tsd-anchor"></a>
<h3>DEDICATED_<wbr>COMPRESSOR_<wbr>32KB</h3>
<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>
<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" data-tsd-kind="Type alias">CompressOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L340">index.d.ts:340</a></li>
<li>Defined in <a href="https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L356">index.d.ts:356</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -220,12 +216,12 @@
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="dedicated_compressor_3kb" class="tsd-anchor"></a>
<a name="DEDICATED_COMPRESSOR_3KB" class="tsd-anchor"></a>
<h3>DEDICATED_<wbr>COMPRESSOR_<wbr>3KB</h3>
<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>
<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" data-tsd-kind="Type alias">CompressOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L332">index.d.ts:332</a></li>
<li>Defined in <a href="https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L348">index.d.ts:348</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -235,12 +231,12 @@
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="dedicated_compressor_4kb" class="tsd-anchor"></a>
<a name="DEDICATED_COMPRESSOR_4KB" class="tsd-anchor"></a>
<h3>DEDICATED_<wbr>COMPRESSOR_<wbr>4KB</h3>
<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>
<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" data-tsd-kind="Type alias">CompressOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L334">index.d.ts:334</a></li>
<li>Defined in <a href="https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L350">index.d.ts:350</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -250,12 +246,12 @@
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="dedicated_compressor_64kb" class="tsd-anchor"></a>
<a name="DEDICATED_COMPRESSOR_64KB" class="tsd-anchor"></a>
<h3>DEDICATED_<wbr>COMPRESSOR_<wbr>64KB</h3>
<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>
<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" data-tsd-kind="Type alias">CompressOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L342">index.d.ts:342</a></li>
<li>Defined in <a href="https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L358">index.d.ts:358</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -265,12 +261,12 @@
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="dedicated_compressor_8kb" class="tsd-anchor"></a>
<a name="DEDICATED_COMPRESSOR_8KB" class="tsd-anchor"></a>
<h3>DEDICATED_<wbr>COMPRESSOR_<wbr>8KB</h3>
<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>
<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" data-tsd-kind="Type alias">CompressOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L336">index.d.ts:336</a></li>
<li>Defined in <a href="https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L352">index.d.ts:352</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -280,12 +276,12 @@
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="disabled" class="tsd-anchor"></a>
<a name="DISABLED" class="tsd-anchor"></a>
<h3>DISABLED</h3>
<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>
<div class="tsd-signature tsd-kind-icon">DISABLED<span class="tsd-signature-symbol">:</span> <a href="index.html#CompressOptions" class="tsd-signature-type" data-tsd-kind="Type alias">CompressOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L328">index.d.ts:328</a></li>
<li>Defined in <a href="https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L344">index.d.ts:344</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -295,12 +291,12 @@
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="shared_compressor" class="tsd-anchor"></a>
<a name="SHARED_COMPRESSOR" class="tsd-anchor"></a>
<h3>SHARED_<wbr>COMPRESSOR</h3>
<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>
<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" data-tsd-kind="Type alias">CompressOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L330">index.d.ts:330</a></li>
<li>Defined in <a href="https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L346">index.d.ts:346</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -313,16 +309,16 @@
<section class="tsd-panel-group tsd-member-group ">
<h2>Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="app" class="tsd-anchor"></a>
<a name="App" class="tsd-anchor"></a>
<h3>App</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">App<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="interfaces/appoptions.html" class="tsd-signature-type">AppOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
<li class="tsd-signature tsd-kind-icon">App<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="interfaces/AppOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AppOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/TemplatedApp.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplatedApp</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L307">index.d.ts:307</a></li>
<li>Defined in <a href="https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L320">index.d.ts:320</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -334,24 +330,24 @@
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="interfaces/appoptions.html" class="tsd-signature-type">AppOptions</a></h5>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="interfaces/AppOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AppOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="interfaces/templatedapp.html" class="tsd-signature-type">TemplatedApp</a></h4>
<h4 class="tsd-returns-title">Returns <a href="interfaces/TemplatedApp.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplatedApp</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="sslapp" class="tsd-anchor"></a>
<a name="SSLApp" class="tsd-anchor"></a>
<h3>SSLApp</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">SSLApp<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="interfaces/appoptions.html" class="tsd-signature-type">AppOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
<li class="tsd-signature tsd-kind-icon">SSLApp<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="interfaces/AppOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AppOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/TemplatedApp.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplatedApp</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L310">index.d.ts:310</a></li>
<li>Defined in <a href="https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L323">index.d.ts:323</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -362,24 +358,24 @@
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>options: <a href="interfaces/appoptions.html" class="tsd-signature-type">AppOptions</a></h5>
<h5>options: <a href="interfaces/AppOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AppOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="interfaces/templatedapp.html" class="tsd-signature-type">TemplatedApp</a></h4>
<h4 class="tsd-returns-title">Returns <a href="interfaces/TemplatedApp.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplatedApp</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="getparts" class="tsd-anchor"></a>
<a name="getParts" class="tsd-anchor"></a>
<h3>get<wbr>Parts</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">get<wbr>Parts<span class="tsd-signature-symbol">(</span>body<span class="tsd-signature-symbol">: </span><a href="index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, contentType<span class="tsd-signature-symbol">: </span><a href="index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/multipartfield.html" class="tsd-signature-type">MultipartField</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li>
<li class="tsd-signature tsd-kind-icon">get<wbr>Parts<span class="tsd-signature-symbol">(</span>body<span class="tsd-signature-symbol">: </span><a href="index.html#RecognizedString" class="tsd-signature-type" data-tsd-kind="Type alias">RecognizedString</a>, contentType<span class="tsd-signature-symbol">: </span><a href="index.html#RecognizedString" class="tsd-signature-type" data-tsd-kind="Type alias">RecognizedString</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L323">index.d.ts:323</a></li>
<li>Defined in <a href="https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L339">index.d.ts:339</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -390,13 +386,13 @@
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>body: <a href="index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
<h5>body: <a href="index.html#RecognizedString" class="tsd-signature-type" data-tsd-kind="Type alias">RecognizedString</a></h5>
</li>
<li>
<h5>contentType: <a href="index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
<h5>contentType: <a href="index.html#RecognizedString" class="tsd-signature-type" data-tsd-kind="Type alias">RecognizedString</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="interfaces/multipartfield.html" class="tsd-signature-type">MultipartField</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h4>
<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>
</li>
</ul>
</section>
@ -404,13 +400,13 @@
<a name="us_listen_socket_close" class="tsd-anchor"></a>
<h3>us_<wbr>listen_<wbr>socket_<wbr>close</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">us_<wbr>listen_<wbr>socket_<wbr>close<span class="tsd-signature-symbol">(</span>listenSocket<span class="tsd-signature-symbol">: </span><a href="interfaces/us_listen_socket.html" class="tsd-signature-type">us_listen_socket</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-signature tsd-kind-icon">us_<wbr>listen_<wbr>socket_<wbr>close<span class="tsd-signature-symbol">(</span>listenSocket<span class="tsd-signature-symbol">: </span><a href="interfaces/us_listen_socket.html" class="tsd-signature-type" data-tsd-kind="Interface">us_listen_socket</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L313">index.d.ts:313</a></li>
<li>Defined in <a href="https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L326">index.d.ts:326</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -421,103 +417,137 @@
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>listenSocket: <a href="interfaces/us_listen_socket.html" class="tsd-signature-type">us_listen_socket</a></h5>
<h5>listenSocket: <a href="interfaces/us_listen_socket.html" class="tsd-signature-type" data-tsd-kind="Interface">us_listen_socket</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="us_socket_local_port" class="tsd-anchor"></a>
<h3>us_<wbr>socket_<wbr>local_<wbr>port</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">us_<wbr>socket_<wbr>local_<wbr>port<span class="tsd-signature-symbol">(</span>socket<span class="tsd-signature-symbol">: </span><a href="interfaces/us_socket.html" class="tsd-signature-type" data-tsd-kind="Interface">us_socket</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L329">index.d.ts:329</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Gets local port of socket (or listenSocket) or -1.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>socket: <a href="interfaces/us_socket.html" class="tsd-signature-type" data-tsd-kind="Interface">us_socket</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals current ">
<a href="index.html"><em>Globals</em></a>
<li class="current ">
<a href="index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum">
<a href="enums/listenoptions.html" class="tsd-kind-icon">Listen<wbr>Options</a>
<a href="enums/ListenOptions.html" class="tsd-kind-icon">Listen<wbr>Options</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
<a href="interfaces/AppOptions.html" class="tsd-kind-icon">App<wbr>Options</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/httprequest.html" class="tsd-kind-icon">Http<wbr>Request</a>
<a href="interfaces/HttpRequest.html" class="tsd-kind-icon">Http<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/httpresponse.html" class="tsd-kind-icon">Http<wbr>Response</a>
<a href="interfaces/HttpResponse.html" class="tsd-kind-icon">Http<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/multipartfield.html" class="tsd-kind-icon">Multipart<wbr>Field</a>
<a href="interfaces/MultipartField.html" class="tsd-kind-icon">Multipart<wbr>Field</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/templatedapp.html" class="tsd-kind-icon">Templated<wbr>App</a>
<a href="interfaces/TemplatedApp.html" class="tsd-kind-icon">Templated<wbr>App</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/websocket.html" class="tsd-kind-icon">Web<wbr>Socket</a>
<a href="interfaces/WebSocket.html" class="tsd-kind-icon">Web<wbr>Socket</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/websocketbehavior.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Behavior</a>
<a href="interfaces/WebSocketBehavior.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Behavior</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/us_socket.html" class="tsd-kind-icon">us_<wbr>socket</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/us_socket_context_t.html" class="tsd-kind-icon">us_<wbr>socket_<wbr>context_<wbr>t</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="index.html#compressoptions" class="tsd-kind-icon">Compress<wbr>Options</a>
<a href="index.html#CompressOptions" class="tsd-kind-icon">Compress<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
<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_128kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>128KB</a>
<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>
<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>
<a href="index.html#DEDICATED_COMPRESSOR_256KB" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>256KB</a>
</li>
<li class=" tsd-kind-variable">
<a href="index.html#dedicated_compressor_32kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>32KB</a>
<a href="index.html#DEDICATED_COMPRESSOR_32KB" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>32KB</a>
</li>
<li class=" tsd-kind-variable">
<a href="index.html#dedicated_compressor_3kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>3KB</a>
<a href="index.html#DEDICATED_COMPRESSOR_3KB" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>3KB</a>
</li>
<li class=" tsd-kind-variable">
<a href="index.html#dedicated_compressor_4kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>4KB</a>
<a href="index.html#DEDICATED_COMPRESSOR_4KB" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>4KB</a>
</li>
<li class=" tsd-kind-variable">
<a href="index.html#dedicated_compressor_64kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>64KB</a>
<a href="index.html#DEDICATED_COMPRESSOR_64KB" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>64KB</a>
</li>
<li class=" tsd-kind-variable">
<a href="index.html#dedicated_compressor_8kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>8KB</a>
<a href="index.html#DEDICATED_COMPRESSOR_8KB" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>8KB</a>
</li>
<li class=" tsd-kind-variable">
<a href="index.html#disabled" class="tsd-kind-icon">DISABLED</a>
<a href="index.html#DISABLED" class="tsd-kind-icon">DISABLED</a>
</li>
<li class=" tsd-kind-variable">
<a href="index.html#shared_compressor" class="tsd-kind-icon">SHARED_<wbr>COMPRESSOR</a>
<a href="index.html#SHARED_COMPRESSOR" class="tsd-kind-icon">SHARED_<wbr>COMPRESSOR</a>
</li>
<li class=" tsd-kind-function">
<a href="index.html#app" class="tsd-kind-icon">App</a>
<a href="index.html#App" class="tsd-kind-icon">App</a>
</li>
<li class=" tsd-kind-function">
<a href="index.html#sslapp" class="tsd-kind-icon">SSLApp</a>
<a href="index.html#SSLApp" class="tsd-kind-icon">SSLApp</a>
</li>
<li class=" tsd-kind-function">
<a href="index.html#getparts" class="tsd-kind-icon">get<wbr>Parts</a>
<a href="index.html#getParts" class="tsd-kind-icon">get<wbr>Parts</a>
</li>
<li class=" tsd-kind-function">
<a href="index.html#us_listen_socket_close" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket_<wbr>close</a>
</li>
<li class=" tsd-kind-function">
<a href="index.html#us_socket_local_port" class="tsd-kind-icon">us_<wbr>socket_<wbr>local_<wbr>port</a>
</li>
</ul>
</nav>
</div>
@ -539,6 +569,5 @@
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
</body>
</html>