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

update docs (#415)

Browse Source
This commit is contained in:
hst-m 2020-12-20 10:34:12 -07:00 committed by GitHub
parent c750931ac7
commit 72994159ab
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/index.d.ts vendored
View File

@ -203,15 +203,15 @@ export interface HttpRequest {
/** A structure holding settings and handlers for a WebSocket URL route handler. */ /** A structure holding settings and handlers for a WebSocket URL route handler. */
export interface WebSocketBehavior { export interface WebSocketBehavior {
/** Maximum length of received message. If a client tries to send you a message larger than this, the connection is immediately closed. */ /** 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. */
maxPayloadLength?: number; maxPayloadLength?: number;
/** Maximum amount of seconds that may pass without sending or getting a message. Connection is closed if this timeout passes. Resolution (granularity) for timeouts are typically 4 seconds, rounded to closest. /** Maximum amount of seconds that may pass without sending or getting a message. Connection is closed if this timeout passes. Resolution (granularity) for timeouts are typically 4 seconds, rounded to closest.
* Disable by leaving 0. * Disable by using 0. Defaults to 120.
*/ */
idleTimeout?: number; idleTimeout?: number;
/** What permessage-deflate compression to use. uWS.DISABLED, uWS.SHARED_COMPRESSOR or any of the uWS.DEDICATED_COMPRESSOR_xxxKB. */ /** What permessage-deflate compression to use. uWS.DISABLED, uWS.SHARED_COMPRESSOR or any of the uWS.DEDICATED_COMPRESSOR_xxxKB. Defaults to uWS.DISABLED. */
compression?: CompressOptions; compression?: CompressOptions;
/** Maximum length of allowed backpressure per socket when PUBLISHING messages (does not apply to ws.send). Slow receivers with too high backpressure will be skipped until they catch up or timeout. */ /** 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. */
maxBackpressure?: number; maxBackpressure?: number;
/** Upgrade handler used to intercept HTTP upgrade requests and potentially upgrade to WebSocket. /** Upgrade handler used to intercept HTTP upgrade requests and potentially upgrade to WebSocket.
* See UpgradeAsync and UpgradeSync example files. * See UpgradeAsync and UpgradeSync example files.