Class: SocketDataHandler

Defined in: socket/data.ts:6

A subclass of SocketEventHandler that handles sending socket data to rooms.

Extends

• SocketEventHandler

Constructors

Constructor

new SocketDataHandler(room, eventName, source, payload): SocketDataHandler

Defined in: socket/index.ts:41

Parameters

room

Room

The Room where the event is happening

eventName

string

The name of the event

source

User

The User associated with the event

payload

IKeyValue

The input values of the event

Returns

SocketDataHandler

Inherited from

SocketEventHandler.constructor

Properties

eventName

protected eventName: string

Defined in: socket/index.ts:21

The event name of a socket event

Inherited from

SocketEventHandler.eventName

---

input

protected input: IKeyValue

Defined in: socket/index.ts:27

The input of the socket event

Inherited from

SocketEventHandler.input

---

output

protected output: SocketIOContextOutput

Defined in: socket/index.ts:24

The output of the socket event

Inherited from

SocketEventHandler.output

---

room

protected room: Room

Defined in: socket/index.ts:30

The room where the event is occurring

Inherited from

SocketEventHandler.room

---

source

protected source: User

Defined in: socket/index.ts:33

The user associated with the event

Inherited from

SocketEventHandler.source

Methods

passthru()

protected passthru(): Promise<void>

Defined in: socket/index.ts:52

Event to Trigger a sendToRooms event.

Returns

Promise<void>

Inherited from

SocketEventHandler.passthru

---

process()

protected process(): Promise<void>

Defined in: socket/index.ts:67

A method to process data/information. Should be overridden in subclasses.

Returns

Promise<void>

Inherited from

SocketEventHandler.process

---

result()

result(): Promise<SocketIOContextOutput>

Defined in: socket/data.ts:15

Sends data to the user, such as information from a tool.

Returns

Promise<SocketIOContextOutput>

Sends data to a room

Overrides

SocketEventHandler.result