Class Emitter<Args>

The base class for classes that hold a set of functions to be called in response to an event or change in value, e.g. Observable and Event.

Type Parameters

Args extends any[] = []

Index

Accessors

Constructors

Methods

addListener clearListeners removeListener

Accessors

next

get next(): Promise<Args>
Returns a promise that will be resolved the next time this object emits.

Returns Promise<Args>
- Defined in emitter.ts:52

Constructors

constructor

new Emitter<Args>(): Emitter<Args>
Type Parameters
- Args extends any[] = []
Returns Emitter<Args>

Methods

addListener

addListener(f, priority?): void
Add a new handler function
Parameters
- f: ((...args: Args) => void)
  The callback function to be bound.
  - - (...args): void
    - Parameters
      Rest...args: Args
      Returns void
- priority: number = 0
Returns void
- Defined in emitter.ts:28

clearListeners

clearListeners(): void
Clears all listeners from the event.

Returns void
- Defined in emitter.ts:18

removeListener

removeListener(f): void
Unbind an existing function
Parameters
- f: ((...args: Args) => void)
  The callback function to be unbound.
  - - (...args): void
    - Parameters
      Rest...args: Args
      Returns void
Returns void
- Defined in emitter.ts:37