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-12-21 20:46:31 +01:00
parent 0526685633
commit 903dc89240
11 changed files with 462 additions and 360 deletions
Download patch file Download diff file Expand all files Collapse all files

58
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 v16.3.0 documentation</title>
<title>uWebSockets.js v16.5.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 v16.3.0 documentation</a>
<a href="index.html" class="title">uWebSockets.js v16.5.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 v16.3.0 documentation</h1>
<h1> uWebSockets.js v16.5.0 documentation</h1>
</div>
</div>
</header>
@ -65,23 +65,23 @@
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-not-exported">
<section class="tsd-index-section ">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<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-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/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>
</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 tsd-is-not-exported"><a href="index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</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 ">
@ -111,7 +111,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/5e205ad/docs/index.d.ts#L170">index.d.ts:170</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L187">index.d.ts:187</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -120,13 +120,13 @@
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-not-exported">
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<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/5e205ad/docs/index.d.ts#L9">index.d.ts:9</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L9">index.d.ts:9</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -144,7 +144,7 @@
<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/5e205ad/docs/index.d.ts#L176">index.d.ts:176</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L193">index.d.ts:193</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -159,7 +159,7 @@
<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/5e205ad/docs/index.d.ts#L172">index.d.ts:172</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L189">index.d.ts:189</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -174,7 +174,7 @@
<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/5e205ad/docs/index.d.ts#L174">index.d.ts:174</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L191">index.d.ts:191</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -196,7 +196,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L161">index.d.ts:161</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L178">index.d.ts:178</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -224,7 +224,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L164">index.d.ts:164</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L181">index.d.ts:181</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -252,7 +252,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L167">index.d.ts:167</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L184">index.d.ts:184</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -282,31 +282,31 @@
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-interface tsd-is-not-exported">
<li class=" tsd-kind-interface">
<a href="interfaces/appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-is-not-exported">
<li class=" tsd-kind-interface">
<a href="interfaces/httprequest.html" class="tsd-kind-icon">Http<wbr>Request</a>
</li>
<li class=" tsd-kind-interface tsd-is-not-exported">
<li class=" tsd-kind-interface">
<a href="interfaces/httpresponse.html" class="tsd-kind-icon">Http<wbr>Response</a>
</li>
<li class=" tsd-kind-interface tsd-is-not-exported">
<li class=" tsd-kind-interface">
<a href="interfaces/templatedapp.html" class="tsd-kind-icon">Templated<wbr>App</a>
</li>
<li class=" tsd-kind-interface tsd-is-not-exported">
<li class=" tsd-kind-interface">
<a href="interfaces/websocket.html" class="tsd-kind-icon">Web<wbr>Socket</a>
</li>
<li class=" tsd-kind-interface tsd-is-not-exported">
<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 tsd-is-not-exported">
<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-type-alias">
<a href="index.html#compressoptions" class="tsd-kind-icon">Compress<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-is-not-exported">
<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">