lgc
/
SmartWebSocket
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme

This commit is contained in:
Luca Conte 2024-08-21 17:02:29 +02:00
parent fc082c45e8
commit 9beec2ff3a
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -2,13 +2,19 @@
```js ```js
// constructor(socketAddress, options = [], autoReconnect = true, debugName = null) // constructor(socketAddress, options = [], autoReconnect = true, debugName = null)
// debugName is used for console logs. If omitted socketAddress will be used instead.
let socket = SmartWebSocket("ws://127.0.0.1:8080", [], true, "sock"); let socket = SmartWebSocket("ws://127.0.0.1:8080", [], true, "sock");
socket.url = "ws://127.0.0.1:8081";
socket.protocols = [];
socket.debugName = "mySock";
// close if connection is open, then re-open connection // close if connection is open, then re-open connection
// applies changes to socket.url and socket.protocols
socket.reconnect() socket.reconnect()
// close socket and disable auto-reconnect // internal WebSocket element.
socket.close() console.log(socket.socket);
// is socket connection open // is socket connection open
if (socket.isReady()) { if (socket.isReady()) {
@ -35,4 +41,7 @@ socket.on("anotherEvent", (data) => {
socket.on("open", (event) => { socket.on("open", (event) => {
console.log(event); console.log(event);
}); });
// close socket and disable auto-reconnect
socket.close()
``` ```