@morojs/moro / WebSocketConnection
Interface: WebSocketConnection
Defined in: src/core/networking/websocket-adapter.ts:108
WebSocket connection interface Represents an individual client connection
Properties
broadcast
broadcast:
WebSocketEmitter
Defined in: src/core/networking/websocket-adapter.ts:159
Emit to all sockets except this one
connected
connected:
boolean
Defined in: src/core/networking/websocket-adapter.ts:174
Check if socket is connected
data
data:
Record<string,any>
Defined in: src/core/networking/websocket-adapter.ts:119
Custom data storage
headers?
optionalheaders:Record<string,string>
Defined in: src/core/networking/websocket-adapter.ts:116
Connection headers
id
id:
string
Defined in: src/core/networking/websocket-adapter.ts:110
Unique connection ID
ip?
optionalip:string
Defined in: src/core/networking/websocket-adapter.ts:113
Client IP address
Methods
compressedEmit()?
optionalcompressedEmit(event,data):void
Defined in: src/core/networking/websocket-adapter.ts:139
Emit with compression
Parameters
event
string
data
any
Returns
void
disconnect()
disconnect(
close?):void
Defined in: src/core/networking/websocket-adapter.ts:169
Disconnect this socket
Parameters
close?
boolean
Returns
void
emit()
emit(
event,data):void
Defined in: src/core/networking/websocket-adapter.ts:134
Emit event to this socket
Parameters
event
string
data
any
Returns
void
getRooms()
getRooms():
Set<string>
Defined in: src/core/networking/websocket-adapter.ts:164
Get rooms this socket has joined
Returns
Set<string>
join()
join(
room):void
Defined in: src/core/networking/websocket-adapter.ts:144
Join a room
Parameters
room
string | string[]
Returns
void
leave()
leave(
room):void
Defined in: src/core/networking/websocket-adapter.ts:149
Leave a room
Parameters
room
string | string[]
Returns
void
on()
on(
event,handler):void
Defined in: src/core/networking/websocket-adapter.ts:124
Listen for events from this socket
Parameters
event
string
handler
(data, callback?) => void
Returns
void
onAny()
onAny(
handler):void
Defined in: src/core/networking/websocket-adapter.ts:129
Listen for any event from this socket
Parameters
handler
(event, ...args) => void
Returns
void
to()
to(
room):WebSocketEmitter
Defined in: src/core/networking/websocket-adapter.ts:154
Emit to specific room(s)
Parameters
room
string | string[]