1.0.6 • Published 3 years ago

mokou-websocket v1.0.6

Weekly downloads
2
License
MIT
Repository
github
Last release
3 years ago

Mokou WebSocket

Reconnecting web socket

Example:

var MokouWebsocket = require("mokou-websocket");
var ws = new MokouWebsocket("ws://127.0.0.1:8001");
ws.onopen=function(e){
	//onopen
}
ws.onclose=function(e){
	//onclose
}
ws.onconnecting=function(e){
	//onconnecting
}
ws.onerror=function(e){
	//onerror
}
ws.onmessage=function(e){
	//onmessage
}

MokouWebsocket

Kind: global class

new MokouWebsocket(url, protocols)

MokouWebsocket - simple reconnecting websocket for nodejs

ParamTypeDefaultDescription
urlstringWebSocket url
protocolsArray.<Object>[]WebSocket protocols

mokouWebsocket.readyState : number

Websocket state

Kind: instance property of MokouWebsocket

mokouWebsocket.onopen(e)

WebSocket events callbacks

Kind: instance method of MokouWebsocket

ParamDescription
eWebSocket event

mokouWebsocket.send(data)

Sends given string to the other side

Kind: instance method of MokouWebsocket

ParamType
datastring

mokouWebsocket.close()

Close WebSocket connection

Kind: instance method of MokouWebsocket

mokouWebsocket.refresh()

Refresh WebSocket connection

Kind: instance method of MokouWebsocket

MokouWebsocket~connect(reconnectAttempt)

Kind: inner method of MokouWebsocket

ParamTypeDefaultDescription
reconnectAttemptboolfalseindicates if MokouWebSocket trying to reconnect to server
1.0.6

3 years ago

1.0.5

8 years ago

1.0.4

8 years ago

1.0.3

8 years ago

1.0.2

8 years ago

1.0.1

8 years ago

1.0.0

8 years ago