Class Emitter<EventNames>

Emitter class that powers the subscribe packet

Type Parameters

EventNames = string

Hierarchy

Emitter

Index

Constructors

Properties

Methods

emit off on once

Constructors

constructor

new Emitter<EventNames>(listeners?: EventHandlerMap): Emitter<EventNames>
Use the constructor to initiate the eventbus with handlers
Type Parameters
- EventNames = string
Parameters
- listeners: EventHandlerMap = {}
Returns Emitter<EventNames>
- Defined in index.ts:25

Properties

listeners

listeners: EventHandlerMap = {}

Methods

emit

emit(type: string & EventNames, evt?: any): void
Invoke this.listeners handlers for the given type. If present, "*" handlers are invoked after type-matched handlers.

Note: Manually firing "*" handlers is not supported.
Parameters
- type: string & EventNames
  
  The event type to invoke
- Optional evt: any
  
  Any value (object is recommended and powerful), passed to each handler
Returns void
- Defined in index.ts:77

off

off(type: string & EventNames, handler?: EventHandler | WildCardEventHandler): void
Remove an event handler for the given type.
Parameters
- type: string & EventNames
  
  Type of event to unregister handler from, or "*"
- Optional handler: EventHandler | WildCardEventHandler
  
  Handler function to remove
Returns void
- Defined in index.ts:58

on

on(type: "*" | string & EventNames, handler: EventHandler | WildCardEventHandler): void
Register an event handler for the given type.
Parameters
- type: "*" | string & EventNames
  
  Type of event to listen for, or "*" for all events
- handler: EventHandler | WildCardEventHandler
  
  Function to call in response to given event
Returns void
- Defined in index.ts:34

once

once(type: string & EventNames, handler: EventHandler): void
Invoke this listener only once
Parameters
- type: string & EventNames
  
  Type of event to emit, or "*" for all events
- handler: EventHandler
Returns void
- Defined in index.ts:44

Generated using TypeDoc