Wrap and document unsubscribeAll, ping

This commit is contained in:
Alex Hultman 2020-01-19 20:24:44 +01:00
parent 2db5895dd7
commit a604881448
12 changed files with 169 additions and 86 deletions

6
docs/index.d.ts vendored
View file

@ -22,12 +22,18 @@ export interface WebSocket {
/** Forcefully closes this WebSocket */
close() : WebSocket;
/** Sends a ping control message. Returns true on success, see WebSocket.send. This helper function correlates to WebSocket::send(message, uWS::OpCode::PING, ...). */
ping(message?: RecognizedString) : boolean;
/** Subscribe to a topic in MQTT syntax */
subscribe(topic: RecognizedString) : WebSocket;
/** Unsubscribe from a topic. Returns true on success, if the WebSocket was subscribed. */
unsubscribe(topic: RecognizedString) : boolean;
/** Unsubscribe from all topics. */
unsubscribeAll() : void;
/** Publish a message to a topic in MQTT syntax */
publish(topic: RecognizedString, message: RecognizedString, isBinary?: boolean, compress?: boolean) : WebSocket;