FluxerFluxer.js
Class

WebSocketShard

Extends EventEmitter

Constructor1Properties15Methods16Source

Constructor

new WebSocketShard(options: WebSocketShardOptions)
ParamTypeDescription
optionsWebSocketShardOptions

Properties

debugEnabled: boolean (readonly)
heartbeatInterval: ReturnType<typeof setInterval> | null
heartbeatTimeout: ReturnType<typeof setTimeout> | null
id: number (readonly)
lastHeartbeatAck: boolean

True until a heartbeat is sent; cleared by HeartbeatAck.

options: WebSocketShardOptions (readonly)
phase: Phase
reconnectDelayMs: number
reconnectTimeout: ReturnType<typeof setTimeout> | null
seq: number | null
sessionId: string | null
status: number (readonly)

Mapped readyState: 0 idle/closed, 1 connecting, 2 open, 3 closing.

url: string (readonly)
ws: WebSocketLike | null
WS: WebSocketConstructor (readonly)

Methods

bindSocket(ws: WebSocketLike): boolean
ParamTypeDescription
wsWebSocketLike
clearReconnectTimer(): void
connect(): void
debug(message: string): void
ParamTypeDescription
messagestring
destroy(): void
handleDispatch(payload: GatewayReceivePayload): void
ParamTypeDescription
payloadGatewayReceivePayload
handleHello(value: unknown): void
ParamTypeDescription
valueunknown
handlePayload(payload: GatewayReceivePayload): void
ParamTypeDescription
payloadGatewayReceivePayload
onClose(code: number): void
ParamTypeDescription
codenumber
onMessage(raw: unknown): void
ParamTypeDescription
rawunknown
onOpen(): void
onSocketError(err?: unknown): void
ParamTypeDescription
err?unknown
scheduleReconnect(): void
send(payload: GatewaySendPayload): void
ParamTypeDescription
payloadGatewaySendPayload
sendHeartbeat(): void
stopHeartbeat(): void