Class Eventer

Pub/Sub for internal event scheduling. All functions are for protected usage. Sub class can use them for implementation of event dispaching.

property: id Unique Eventer id

Hierarchy

Eventer

Index

Constructors

constructor

Properties

id

Methods

Constructors

constructor

new Eventer(): Eventer

- Defined in src/eventer.ts:71
Returns Eventer

Properties

Readonly id

id: number = ++lastId

Unique id

Methods

allOff

allOff(): this

- Defined in src/eventer.ts:160
Remove all topics with all listeners

Returns this

emit

emit(topic: string, ...args: Array<any>): number

- Defined in src/eventer.ts:178
Emit event and call subscribed listeners

Parameters
- topic: string
  
  Topic name
- Rest ...args: Array<any>
  
  Array of arguments
Returns number

Number of listeners called

has

has(token: Token, topic?: undefined | string): EventError | Listener

- Defined in src/eventer.ts:100
Check if listener with provided token exists

Parameters
- token: Token
  
  Token of desired listener
- Optional topic: undefined | string
  
  Topic which has to contain the listener
Returns EventError | Listener

Error with message or Listener

listeners

listeners(topic: string): Map<Token, Listener>

- Defined in src/eventer.ts:199
Get All listeners at the topic

Parameters
- topic: string
  
  Topic name
Returns Map<Token, Listener>

off

off(token: Token, topic?: undefined | string): boolean

- Defined in src/eventer.ts:136
Remove listener with provided token

Parameters
- token: Token
  
  Token of the listener
- Optional topic: undefined | string
  
  Topic which has to contain the listener
Returns boolean

True if the listener is successfully removed and false if it is not found

on

on(topic: string, listener: Listener, oldToken?: Token): Token

- Defined in src/eventer.ts:82
Register subscription on the topic with provided listener

Parameters
- topic: string
  
  Topic name
- listener: Listener
  
  Event listener
- Optional oldToken: Token
  
  Old token, if it has to be reused
Returns Token

topicOff

topicOff(topic: string): boolean

- Defined in src/eventer.ts:169
Remove topic with all listeners

Parameters
- topic: string
  
  Topic name
Returns boolean

True if the topic is successfully removed and false if it is not found