jprdonnelly/uWebSockets.js
1
0
Fork 0
mirror of https://github.com/uNetworking/uWebSockets.js.git synced 2026-04-28 14:00:07 -04:00
Code Issues Projects Releases Wiki Activity

fix docs (#704)

Browse Source
This commit is contained in:
e3dio
2022-05-04 10:54:19 -07:00
committed by GitHub
parent 63c9759d66
commit 0c6615488d
2 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/generated/interfaces/WebSocketBehavior.html
View File

@@ -9,7 +9,7 @@ Disable by using 0. Defaults to 120.</p>
<p>Maximum length of allowed backpressure per socket when publishing or sending messages. Slow receivers with too high backpressure will be skipped until they catch up or timeout. Defaults to 1024 * 1024.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="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/master/docs/index.d.ts#L218">index.d.ts:218</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Maximum length of received message. If a client tries to send you a message larger than this, the connection is immediately closed. Defaults to 16 * 1024.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="sendPingsAutomatically" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> send<wbr/>Pings<wbr/>Automatically</h3><div class="tsd-signature tsd-kind-icon">send<wbr/>Pings<wbr/>Automatically<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/master/docs/index.d.ts#L228">index.d.ts:228</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="sendPingsAutomatically" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> send<wbr/>Pings<wbr/>Automatically</h3><div class="tsd-signature tsd-kind-icon">send<wbr/>Pings<wbr/>Automatically<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L228">index.d.ts:228</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Whether or not we should automatically send pings to uphold a stable connection given whatever idleTimeout.</p>
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="close" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> close</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">close<span class="tsd-signature-symbol">(</span>ws<span class="tsd-signature-symbol">: </span><a href="WebSocket.html" class="tsd-signature-type" data-tsd-kind="Interface">WebSocket</a>, code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span><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/master/docs/index.d.ts#L240">index.d.ts:240</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Handler for close event, no matter if error, timeout or graceful close. You may not use WebSocket after this event. Do not send on this WebSocket from within here, it is closed.</p>