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

Update docs for v16.0.0

Browse source
This commit is contained in:
Alex Hultman 2019-10-09 15:24:56 +02:00
parent cfbcb55b03
commit d605d97fa3
19 changed files with 2364 additions and 871 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/index.d.ts vendored
View file

@ -25,11 +25,11 @@ interface WebSocket {
/** Subscribe to a topic in MQTT syntax */
subscribe(topic: RecognizedString) : WebSocket;
/** Publish a message to a topic in MQTT syntax */
publish(topic: RecognizedString, message: RecognizedString) : WebSocket;
/** Unsubscribe from a topic. Returns true on success, if the WebSocket was subscribed. */
unsubscribe(topic: RecognizedString) : boolean;
/** Unsubscribe from topic (not implemented yet) */
unsubscribe(topic: RecognizedString) : WebSocket;
/** Publish a message to a topic in MQTT syntax */
publish(topic: RecognizedString, message: RecognizedString, isBinary?: boolean, compress?: boolean) : WebSocket;
/** Returns the remote IP address */
getRemoteAddress() : ArrayBuffer;
@ -103,6 +103,8 @@ interface WebSocketBehavior {
idleTimeout?: number;
/** 0 = no compression, 1 = shared compressor, 2 = dedicated compressor. See C++ project. */
compression?: CompressOptions;
/** Maximum length of allowed backpressure per socket when publishing messages. Slow receivers, WebSockets, will be disconnected if needed. */
maxBackpressure?: number;
/** Handler for new WebSocket connection. WebSocket is valid from open to close, no errors. */
open?: (ws: WebSocket, req: HttpRequest) => void;
/** Handler for a WebSocket message. */