Class EventQueueNone

Dummy EventQueue for which no queue is utilized.

Every event is handled as soon as its data is available.

Hierarchy

EventQueue
- EventQueueNone

Index

Constructors

constructor

Properties

consumeFn

Methods

Constructors

constructor

new EventQueueNone(consumeFn: ConsumeCallback): EventQueueNone

Inherited from EventQueue.constructor
- Defined in src/components/event-queue.ts:149
Parameters
- consumeFn: ConsumeCallback
Returns EventQueueNone

Properties

Protected consumeFn

consumeFn: ConsumeCallback

Methods

consume

consume(): void

Overrides EventQueue.consume
- Defined in src/components/event-queue.ts:159
Returns void

push

push(event: unknown, dataReady: DataReady): void

Overrides EventQueue.push
- Defined in src/components/event-queue.ts:154
Parameters
- event: unknown
- dataReady: DataReady
Returns void

Static create

create(opts: { type: "none" | "single" | "per_room" }, consumeFn: ConsumeCallback): EventQueueSingle | EventQueuePerRoom | EventQueueNone

Inherited from EventQueue.create
- Defined in src/components/event-queue.ts:105
Factory for EventQueues.

Parameters
- opts: { type: "none" | "single" | "per_room" }
  - type: "none" | "single" | "per_room"
    
    Type of the queue to create.
- consumeFn: ConsumeCallback
  
  Function which is called when an event is consumed.
Returns EventQueueSingle | EventQueuePerRoom | EventQueueNone

The newly created EventQueue.

Generated using TypeDoc