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

Update docs

Browse Source
This commit is contained in:
Alex Hultman 2019-02-21 20:03:43 +01:00
parent dcfbd23146
commit 8c763c4df8
11 changed files with 357 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

File diff suppressed because one or more lines are too long

267
docs/generated/enums/compressoptions.html Normal file
View File

@ -0,0 +1,267 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>CompressOptions | uWebSockets.js v15.1.0 documentation (WIP &amp; incomplete)</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<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 v15.1.0 documentation (WIP &amp; incomplete)</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</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>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">Globals</a>
</li>
<li>
<a href="compressoptions.html">CompressOptions</a>
</li>
</ul>
<h1>Enumeration CompressOptions</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>WebSocket compression options</p>
</div>
</div>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Enumeration members</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="compressoptions.html#dedicated_compressor" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="compressoptions.html#disabled" class="tsd-kind-icon">DISABLED</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="compressoptions.html#shared_compressor" class="tsd-kind-icon">SHARED_<wbr>COMPRESSOR</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Enumeration members</h2>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<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> </div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L153">index.d.ts:153</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Sliding dedicated compress window, requires lots of memory per socket</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="disabled" class="tsd-anchor"></a>
<h3>DISABLED</h3>
<div class="tsd-signature tsd-kind-icon">DISABLED<span class="tsd-signature-symbol">:</span> </div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L149">index.d.ts:149</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>No compression (always a good idea)</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<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> </div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L151">index.d.ts:151</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Zero memory overhead compression (recommended)</p>
</div>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../index.html"><em>Globals</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-enum">
<a href="compressoptions.html" class="tsd-kind-icon">Compress<wbr>Options</a>
<ul>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="compressoptions.html#dedicated_compressor" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="compressoptions.html#disabled" class="tsd-kind-icon">DISABLED</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="compressoptions.html#shared_compressor" class="tsd-kind-icon">SHARED_<wbr>COMPRESSOR</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-is-not-exported">
<a href="../interfaces/appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-is-not-exported">
<a href="../interfaces/httprequest.html" class="tsd-kind-icon">Http<wbr>Request</a>
</li>
<li class=" tsd-kind-interface tsd-is-not-exported">
<a href="../interfaces/httpresponse.html" class="tsd-kind-icon">Http<wbr>Response</a>
</li>
<li class=" tsd-kind-interface tsd-is-not-exported">
<a href="../interfaces/templatedapp.html" class="tsd-kind-icon">Templated<wbr>App</a>
</li>
<li class=" tsd-kind-interface tsd-is-not-exported">
<a href="../interfaces/websocket.html" class="tsd-kind-icon">Web<wbr>Socket</a>
</li>
<li class=" tsd-kind-interface tsd-is-not-exported">
<a href="../interfaces/websocketbehavior.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Behavior</a>
</li>
<li class=" tsd-kind-interface tsd-is-not-exported">
<a href="../interfaces/us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</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#us_listen_socket_close" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket_<wbr>close</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</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>

15
docs/generated/index.html
View File

@ -65,6 +65,12 @@
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Enumerations</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-enum"><a href="enums/compressoptions.html" class="tsd-kind-icon">Compress<wbr>Options</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-not-exported">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
@ -100,7 +106,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L138">index.d.ts:138</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L138">index.d.ts:138</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -128,7 +134,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L141">index.d.ts:141</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L141">index.d.ts:141</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -156,7 +162,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L144">index.d.ts:144</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L144">index.d.ts:144</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -186,6 +192,9 @@
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum">
<a href="enums/compressoptions.html" class="tsd-kind-icon">Compress<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-is-not-exported">
<a href="interfaces/appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
</li>

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

@ -103,7 +103,7 @@
<div class="tsd-signature tsd-kind-icon">cert_<wbr>file_<wbr>name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L102">index.d.ts:102</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L102">index.d.ts:102</a></li>
</ul>
</aside>
</section>
@ -113,7 +113,7 @@
<div class="tsd-signature tsd-kind-icon">dh_<wbr>params_<wbr>file_<wbr>name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L104">index.d.ts:104</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L104">index.d.ts:104</a></li>
</ul>
</aside>
</section>
@ -123,7 +123,7 @@
<div class="tsd-signature tsd-kind-icon">key_<wbr>file_<wbr>name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L101">index.d.ts:101</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L101">index.d.ts:101</a></li>
</ul>
</aside>
</section>
@ -133,7 +133,7 @@
<div class="tsd-signature tsd-kind-icon">passphrase<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L103">index.d.ts:103</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L103">index.d.ts:103</a></li>
</ul>
</aside>
</section>
@ -149,6 +149,9 @@
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum">
<a href="../enums/compressoptions.html" class="tsd-kind-icon">Compress<wbr>Options</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-is-not-exported">

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

@ -108,7 +108,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L70">index.d.ts:70</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L70">index.d.ts:70</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -136,7 +136,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L76">index.d.ts:76</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L76">index.d.ts:76</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -158,7 +158,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L72">index.d.ts:72</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L72">index.d.ts:72</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -186,7 +186,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L78">index.d.ts:78</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L78">index.d.ts:78</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -208,7 +208,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L74">index.d.ts:74</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L74">index.d.ts:74</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -232,6 +232,9 @@
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum">
<a href="../enums/compressoptions.html" class="tsd-kind-icon">Compress<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-is-not-exported">
<a href="appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
</li>

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

@ -113,7 +113,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L46">index.d.ts:46</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L46">index.d.ts:46</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -135,7 +135,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L41">index.d.ts:41</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L41">index.d.ts:41</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -163,7 +163,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L49">index.d.ts:49</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L49">index.d.ts:49</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -185,7 +185,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L61">index.d.ts:61</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L61">index.d.ts:61</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -234,7 +234,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L64">index.d.ts:64</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L64">index.d.ts:64</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -286,7 +286,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L55">index.d.ts:55</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L55">index.d.ts:55</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -334,7 +334,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L43">index.d.ts:43</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L43">index.d.ts:43</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -365,7 +365,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L39">index.d.ts:39</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L39">index.d.ts:39</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -393,7 +393,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L37">index.d.ts:37</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L37">index.d.ts:37</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -424,7 +424,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L35">index.d.ts:35</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L35">index.d.ts:35</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -454,6 +454,9 @@
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum">
<a href="../enums/compressoptions.html" class="tsd-kind-icon">Compress<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-is-not-exported">
<a href="appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
</li>

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

@ -115,7 +115,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L132">index.d.ts:132</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L132">index.d.ts:132</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -167,7 +167,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L128">index.d.ts:128</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L128">index.d.ts:128</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -219,7 +219,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L120">index.d.ts:120</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L120">index.d.ts:120</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -271,7 +271,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L114">index.d.ts:114</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L114">index.d.ts:114</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -323,7 +323,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L126">index.d.ts:126</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L126">index.d.ts:126</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -376,7 +376,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L110">index.d.ts:110</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L110">index.d.ts:110</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -419,7 +419,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L112">index.d.ts:112</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L112">index.d.ts:112</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -468,7 +468,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L118">index.d.ts:118</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L118">index.d.ts:118</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -520,7 +520,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L122">index.d.ts:122</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L122">index.d.ts:122</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -572,7 +572,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L116">index.d.ts:116</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L116">index.d.ts:116</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -624,7 +624,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L124">index.d.ts:124</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L124">index.d.ts:124</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -676,7 +676,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L130">index.d.ts:130</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L130">index.d.ts:130</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -728,7 +728,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L134">index.d.ts:134</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L134">index.d.ts:134</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -761,6 +761,9 @@
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum">
<a href="../enums/compressoptions.html" class="tsd-kind-icon">Compress<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-is-not-exported">
<a href="appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
</li>

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

@ -90,6 +90,9 @@
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum">
<a href="../enums/compressoptions.html" class="tsd-kind-icon">Compress<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-is-not-exported">
<a href="appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
</li>

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

@ -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/20200a8/docs/index.d.ts#L20">index.d.ts:20</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L20">index.d.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -132,7 +132,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L17">index.d.ts:17</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L17">index.d.ts:17</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -163,7 +163,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L14">index.d.ts:14</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L14">index.d.ts:14</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -185,7 +185,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L26">index.d.ts:26</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L26">index.d.ts:26</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -216,7 +216,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L11">index.d.ts:11</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L11">index.d.ts:11</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -250,7 +250,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L23">index.d.ts:23</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L23">index.d.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -278,7 +278,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/20200a8/docs/index.d.ts#L29">index.d.ts:29</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L29">index.d.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -308,6 +308,9 @@
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum">
<a href="../enums/compressoptions.html" class="tsd-kind-icon">Compress<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-is-not-exported">
<a href="appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
</li>

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

@ -106,7 +106,7 @@
<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/20200a8/docs/index.d.ts#L96">index.d.ts:96</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L96">index.d.ts:96</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -148,7 +148,7 @@
<div class="tsd-signature tsd-kind-icon">compression<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/20200a8/docs/index.d.ts#L88">index.d.ts:88</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L88">index.d.ts:88</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -163,7 +163,7 @@
<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/20200a8/docs/index.d.ts#L94">index.d.ts:94</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L94">index.d.ts:94</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -199,7 +199,7 @@
<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/20200a8/docs/index.d.ts#L86">index.d.ts:86</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L86">index.d.ts:86</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -214,7 +214,7 @@
<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/20200a8/docs/index.d.ts#L84">index.d.ts:84</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L84">index.d.ts:84</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -229,7 +229,7 @@
<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/20200a8/docs/index.d.ts#L92">index.d.ts:92</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L92">index.d.ts:92</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -271,7 +271,7 @@
<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/20200a8/docs/index.d.ts#L90">index.d.ts:90</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L90">index.d.ts:90</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -316,6 +316,9 @@
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum">
<a href="../enums/compressoptions.html" class="tsd-kind-icon">Compress<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-is-not-exported">
<a href="appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
</li>

10
docs/index.d.ts vendored
View File

@ -142,3 +142,13 @@ export function SSLApp(options: AppOptions): TemplatedApp;
/** Closes a uSockets listen socket. */
export function us_listen_socket_close(listenSocket: us_listen_socket): void;
/** WebSocket compression options */
export enum CompressOptions {
/** No compression (always a good idea) */
DISABLED,
/** Zero memory overhead compression (recommended) */
SHARED_COMPRESSOR,
/** Sliding dedicated compress window, requires lots of memory per socket */
DEDICATED_COMPRESSOR
}