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 2020-06-08 14:29:54 +02:00
parent 1b6c029cc1
commit cc3c551831
19 changed files with 1368 additions and 2344 deletions
Download patch file Download diff file Expand all files Collapse all files

77
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.6.0 documentation</title>
<title>WebSocketBehavior | uWebSockets.js v18.1.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.6.0 documentation</a>
<a href="../index.html" class="title">uWebSockets.js v18.1.0 documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -96,6 +96,7 @@
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="websocketbehavior.html#open" class="tsd-kind-icon">open</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="websocketbehavior.html#ping" class="tsd-kind-icon">ping</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="websocketbehavior.html#pong" class="tsd-kind-icon">pong</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="websocketbehavior.html#upgrade" class="tsd-kind-icon">upgrade</a></li>
</ul>
</section>
</div>
@ -109,7 +110,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/be45fb6/docs/index.d.ts#L178">index.d.ts:178</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/1b6c029/docs/index.d.ts#L203">index.d.ts:203</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -151,7 +152,7 @@
<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/be45fb6/docs/index.d.ts#L166">index.d.ts:166</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/1b6c029/docs/index.d.ts#L187">index.d.ts:187</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -166,7 +167,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/be45fb6/docs/index.d.ts#L176">index.d.ts:176</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/1b6c029/docs/index.d.ts#L201">index.d.ts:201</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -202,7 +203,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/be45fb6/docs/index.d.ts#L164">index.d.ts:164</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/1b6c029/docs/index.d.ts#L185">index.d.ts:185</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -218,7 +219,7 @@
<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/be45fb6/docs/index.d.ts#L168">index.d.ts:168</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/1b6c029/docs/index.d.ts#L189">index.d.ts:189</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -233,7 +234,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/be45fb6/docs/index.d.ts#L160">index.d.ts:160</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/1b6c029/docs/index.d.ts#L181">index.d.ts:181</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -248,7 +249,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/be45fb6/docs/index.d.ts#L174">index.d.ts:174</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/1b6c029/docs/index.d.ts#L199">index.d.ts:199</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -290,7 +291,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/be45fb6/docs/index.d.ts#L172">index.d.ts:172</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/1b6c029/docs/index.d.ts#L197">index.d.ts:197</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -330,7 +331,7 @@
<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/be45fb6/docs/index.d.ts#L180">index.d.ts:180</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/1b6c029/docs/index.d.ts#L205">index.d.ts:205</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -366,7 +367,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/be45fb6/docs/index.d.ts#L182">index.d.ts:182</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/1b6c029/docs/index.d.ts#L207">index.d.ts:207</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -396,6 +397,49 @@
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="upgrade" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> upgrade</h3>
<div class="tsd-signature tsd-kind-icon">upgrade<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/1b6c029/docs/index.d.ts#L193">index.d.ts:193</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Upgrade handler used to intercept HTTP upgrade requests and potentially upgrade to WebSocket.
See UpgradeAsync and UpgradeSync example files.</p>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a>, context<span class="tsd-signature-symbol">: </span><a href="us_socket_context_t.html" class="tsd-signature-type">us_socket_context_t</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">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>res: <a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a></h5>
</li>
<li>
<h5>req: <a href="httprequest.html" class="tsd-signature-type">HttpRequest</a></h5>
</li>
<li>
<h5>context: <a href="us_socket_context_t.html" class="tsd-signature-type">us_socket_context_t</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
@ -458,6 +502,9 @@
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="websocketbehavior.html#pong" class="tsd-kind-icon">pong</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="websocketbehavior.html#upgrade" class="tsd-kind-icon">upgrade</a>
</li>
</ul>
</li>
</ul>
@ -465,6 +512,9 @@
<li class=" tsd-kind-interface">
<a href="us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
</li>
<li class=" tsd-kind-interface">
<a href="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>
</li>
@ -527,7 +577,6 @@
<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>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
@ -576,7 +625,7 @@
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
<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>