Class EventBus<T>`Abstract`

Type Parameters

T extends Event

Hierarchy

EventBus
- LoggerEvent

Index

Constructors

Properties

sendEvent subscriptions

Methods

emit off on once unsubscribeAll unsubscribeAllForEvent

Constructors

constructor

new EventBus<T>(): EventBus<T>
Type Parameters
- T extends Event
Returns EventBus<T>

Properties

sendEvent

sendEvent: undefined | (<E>(event: E, data: T[E]) => void) = undefined

Optionally expose the emit functionality outside the implementor

`Protected` subscriptions

subscriptions: Subscription<T> = {}

Methods

`Protected` emit

emit<E>(event: E, data: T[E]): void
emit an event
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
- data: T[E]
Returns void
- Defined in app-util/src/shared/event-bus.class.ts:37

`Protected` off

off<E>(event: E, cb: ((val: T[E]) => void)): void
Unregister the listener for an event the reference of the callback function
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
- cb: ((val: T[E]) => void)
  - - (val: T[E]): void
    - Parameters
      
      val: T[E]
      
      Returns void
Returns void
- Defined in app-util/src/shared/event-bus.class.ts:45

on

on<E>(event: E, cb: ((val: T[E]) => void)): (() => void)
Register an event and pass a callback

Returns
Void|Function , Void if the handler is already registered or Function if the handler is registered
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
- cb: ((val: T[E]) => void)
  - - (val: T[E]): void
    - Parameters
      
      val: T[E]
      
      Returns void
Returns (() => void)
- - (): void
  - Register an event and pass a callback
    
    Returns
    Void|Function , Void if the handler is already registered or Function if the handler is registered
    
    Returns void
- Defined in app-util/src/shared/event-bus.class.ts:24

once

once<E>(event: E, cb: ((val: T[E]) => void)): (() => void)
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
- cb: ((val: T[E]) => void)
  - - (val: T[E]): void
    - Parameters
      
      val: T[E]
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
- Defined in app-util/src/shared/event-bus.class.ts:51

unsubscribeAll

unsubscribeAll(): void
Returns void
- Defined in app-util/src/shared/event-bus.class.ts:62

unsubscribeAllForEvent

unsubscribeAllForEvent<E>(event: E): void
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
Returns void
- Defined in app-util/src/shared/event-bus.class.ts:66

Generated using TypeDoc