@morojs/moro / WebSocketConnection
Interface: WebSocketConnection
Defined in: src/core/networking/websocket-adapter.ts:143
WebSocket connection interface Represents an individual client connection
Properties
broadcast
broadcast:
WebSocketEmitter
Defined in: src/core/networking/websocket-adapter.ts:202
Emit to all sockets except this one
connected
connected:
boolean
Defined in: src/core/networking/websocket-adapter.ts:217
Check if socket is connected
data
data:
Record<string,any>
Defined in: src/core/networking/websocket-adapter.ts:154
Custom data storage
headers?
optionalheaders?:Record<string,string>
Defined in: src/core/networking/websocket-adapter.ts:151
Connection headers
id
id:
string
Defined in: src/core/networking/websocket-adapter.ts:145
Unique connection ID
ip?
optionalip?:string
Defined in: src/core/networking/websocket-adapter.ts:148
Client IP address
Methods
compressedEmit()?
optionalcompressedEmit(event,data):void
Defined in: src/core/networking/websocket-adapter.ts:174
Emit with compression
Parameters
event
string
data
any
Returns
void
disconnect()
disconnect(
close?):void
Defined in: src/core/networking/websocket-adapter.ts:212
Disconnect this socket
Parameters
close?
boolean
Returns
void
emit()
emit(
event,data):void
Defined in: src/core/networking/websocket-adapter.ts:169
Emit event to this socket
Parameters
event
string
data
any
Returns
void
getRooms()
getRooms():
Set<string>
Defined in: src/core/networking/websocket-adapter.ts:207
Get rooms this socket has joined
Returns
Set<string>
join()
join(
room):void
Defined in: src/core/networking/websocket-adapter.ts:187
Join a room
Parameters
room
string | string[]
Returns
void
leave()
leave(
room):void
Defined in: src/core/networking/websocket-adapter.ts:192
Leave a room
Parameters
room
string | string[]
Returns
void
on()
on(
event,handler):void
Defined in: src/core/networking/websocket-adapter.ts:159
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:164
Listen for any event from this socket
Parameters
handler
(event, ...args) => void
Returns
void
send()?
optionalsend(data,isBinary?):void
Defined in: src/core/networking/websocket-adapter.ts:182
Send one frame as-is, with no { event, data } envelope: a string goes
out as a text frame, a Buffer/ArrayBuffer/Uint8Array as a binary frame
(isBinary overrides the guess). The reply side of a raw namespace; every
built-in adapter implements it.
Parameters
data
string | ArrayBuffer | Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>
isBinary?
boolean
Returns
void
to()
to(
room):WebSocketEmitter
Defined in: src/core/networking/websocket-adapter.ts:197
Emit to specific room(s)
Parameters
room
string | string[]