Update docs for v16.0.0
This commit is contained in:
Alex Hultman
parent
cfbcb55b03
commit
d605d97fa3
19 changed files with 2364 additions and 871 deletions
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>WebSocketBehavior | uWebSockets.js v15.11.0 documentation</title>
|
||||
<title>WebSocketBehavior | uWebSockets.js v16.0.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 v15.11.0 documentation</a>
|
||||
<a href="../index.html" class="title">uWebSockets.js v16.0.0 documentation</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
|
|
@ -90,6 +90,7 @@
|
|||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="websocketbehavior.html#compression" class="tsd-kind-icon">compression</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="websocketbehavior.html#drain" class="tsd-kind-icon">drain</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="websocketbehavior.html#idletimeout" class="tsd-kind-icon">idle<wbr>Timeout</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="websocketbehavior.html#maxbackpressure" class="tsd-kind-icon">max<wbr>Backpressure</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="websocketbehavior.html#maxpayloadlength" class="tsd-kind-icon">max<wbr>Payload<wbr>Length</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="websocketbehavior.html#message" class="tsd-kind-icon">message</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="websocketbehavior.html#open" class="tsd-kind-icon">open</a></li>
|
||||
|
|
@ -106,7 +107,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/a5cf0db/docs/index.d.ts#L113">index.d.ts:113</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L115">index.d.ts:115</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -148,7 +149,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">compression<span class="tsd-signature-symbol">:</span> <a href="../enums/compressoptions.html" class="tsd-signature-type">CompressOptions</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L105">index.d.ts:105</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L105">index.d.ts:105</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -163,7 +164,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/a5cf0db/docs/index.d.ts#L111">index.d.ts:111</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L113">index.d.ts:113</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -199,7 +200,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/a5cf0db/docs/index.d.ts#L103">index.d.ts:103</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L103">index.d.ts:103</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -208,13 +209,28 @@
|
|||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<a name="maxbackpressure" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr>Backpressure</h3>
|
||||
<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/cfbcb55/docs/index.d.ts#L107">index.d.ts:107</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Maximum length of allowed backpressure per socket when publishing messages. Slow receivers, WebSockets, will be disconnected if needed.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<a name="maxpayloadlength" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr>Payload<wbr>Length</h3>
|
||||
<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/a5cf0db/docs/index.d.ts#L101">index.d.ts:101</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L101">index.d.ts:101</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -229,7 +245,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/a5cf0db/docs/index.d.ts#L109">index.d.ts:109</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L111">index.d.ts:111</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -271,7 +287,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/a5cf0db/docs/index.d.ts#L107">index.d.ts:107</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L109">index.d.ts:109</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -351,6 +367,9 @@
|
|||
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<a href="websocketbehavior.html#idletimeout" class="tsd-kind-icon">idle<wbr>Timeout</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<a href="websocketbehavior.html#maxbackpressure" class="tsd-kind-icon">max<wbr>Backpressure</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<a href="websocketbehavior.html#maxpayloadlength" class="tsd-kind-icon">max<wbr>Payload<wbr>Length</a>
|
||||
</li>
|
||||
|
|
@ -396,6 +415,7 @@
|
|||
<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>
|
||||
|
|
@ -444,7 +464,7 @@
|
|||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue