Class Emitter<E>

A type-safe event emitter.

Type Parameters

E

The interface that maps event names and event objects.

Hierarchy

Emitter

Index

Constructors

Methods

Constructors

constructor

new Emitter<E>(): Emitter<E>
Type Parameters
- E
Returns Emitter<E>
- Defined in core/src/common/model/emitter.ts:20

Methods

emit

emit<EventName>(eventName: EventName, event: E[EventName]): void
Type Parameters
- EventName extends string | number | symbol
Parameters
- eventName: EventName
- event: E[EventName]
Returns void
- Defined in core/src/common/model/emitter.ts:71

off

off<EventName>(eventName: EventName, key: unknown): Emitter<E>
Removes an event listener from the emitter.
Type Parameters
- EventName extends string | number | symbol
Parameters
- eventName: EventName
  
  The event name.
- key: unknown
  
  The event handler to remove, or the key for removing the handler.
Returns Emitter<E>
- Defined in core/src/common/model/emitter.ts:56

on

on<EventName>(eventName: EventName, handler: Handler<E[EventName]>, opt_options?: {
key: unknown;
}): Emitter<E>
Adds an event listener to the emitter.
Type Parameters
- EventName extends string | number | symbol
Parameters
- eventName: EventName
  
  The event name to listen.
- handler: Handler<E[EventName]>
  
  The event handler.
- Optional opt_options: {
  key: unknown;
  }
  
  The options.
  - key: unknown
    
    The key that can be used for removing the handler.
Returns Emitter<E>
- Defined in core/src/common/model/emitter.ts:31

Generated using TypeDoc