Skip to content

WebSocketManager

Package: @erinjs/ws

Constructor

NameTypeOptionalDescription
optionsWebSocketManagerOptionsNo

Properties

NameTypeReadonlyOptionalDescription
gatewayUrlstring | nullNoNo
optionsWebSocketManagerOptionsYesNo
shardCountnumberNoNo
shardsMap<number, WebSocketShard>NoNo

Methods

connect() async

Returns: Promise<void>

Parameters:

None


destroy()

Returns: void

Parameters:

None


getShardCount()

Returns: number

Parameters:

None


send()

Returns: void

Parameters:

NameTypeOptionalDescription
shardIdnumberNo
payloadGatewaySendPayloadNo

Released under the Apache-2.0 License.