WebSocketClient - Documentation

Constructor

new WebSocketClient(optionsopt)

Source:

lib/websocket/client.js, line 12

Parameters:

Name Type Attributes Description

options

Object

options object

Properties

Name Type Attributes Default Description

uri

String

ws://localhost:9500

Full URI of server to connect to

id

String

UUID

Unique ID of client, defaults to random UUID

serializer

Serializer

singleton with an encode and decode object to be used

Properties

Name	Type	Attributes	Default	Description
`encode`	function	<optional>	`msgpack5/encode`	encoder function
`decode`	function	<optional>	`msgpack5/decode`	decoder function

logger

logger | Boolean

{logger}

Optional logger to pass in, or use a default instance of {logger} set to debug level

options

Object

See WS options

Members

blacklist

Source:

lib/websocket/client.js, line 52

Properties:

Name	Type	Description
`blacklistNamespaces`	String	array of namespaces that will be filtered out in pub()

client

Source:

lib/websocket/client.js, line 85

See:

Properties:

Name	Type	Description
`WS`	Object	client

closed

Source:

lib/websocket/client.js, line 162

Properties:

Name	Type	Description
`connecting`	Boolean	client is closed

closing

Source:

lib/websocket/client.js, line 155

Properties:

Name	Type	Description
`connecting`	Boolean	client is closeing

connecting

Source:

lib/websocket/client.js, line 141

Properties:

Name	Type	Description
`connecting`	Boolean	client is connecting

id

Source:

lib/websocket/client.js, line 38

Properties:

Name	Type	Description
`id`	String	Current `id` of client. Defaults to random `UUID()`

message

Source:

lib/websocket/client.js, line 80

Properties:

Name	Type	Description
`message`	Message

open

Source:

lib/websocket/client.js, line 148

Properties:

Name	Type	Description
`connecting`	Boolean	client is open

subscribed

Source:

lib/websocket/client.js, line 76

Properties:

Name	Type	Description
`subscribed`	Array	Curret subscribed events. Defaults to `['connect']`

uri

Source:

lib/websocket/client.js, line 70

Properties:

Name	Type	Description
`uri`	String	`uri` which `client` uses to connect

Methods

close() → {WebSocketClient}

Source:

lib/websocket/client.js, line 188

close the client connection

Returns:

Type: WebSocketClient

pub(namespace, payload, callbackopt) → {WebSocketClient}

Source:

lib/websocket/client.js, line 174

pub Publish a payload to a given event namespace

Parameters:

Name	Type	Attributes	Default	Description
`namespace`	String			delimited namespace to publish on
`payload`	Number \| String \| Object		`''`	the payload object to publish
`callback`	function	<optional>		optional callback for message sent

Returns:

Type: WebSocketClient

Events

close

Source:

lib/websocket/client.js, line 97

client has closed connection

connect

Source:

lib/websocket/client.js, line 102

client has received a connect event

Type:

String

ready

Source:

lib/websocket/client.js, line 89

client has opened and is ready