Class Observable

Observable

Adds event listener functionality

Hierarchy

Observable

Index

Constructors

Properties

Methods

fire on onFirstListenerAdded once relayEvent un

Constructors

constructor

new Observable(): Observable
Returns Observable

Properties

`Private` lisnrs

lisnrs: undefined | {
    [key: string]: {
        listener: Function;
        options?: ObservableListenerOpts;
        unbindkey: Listener;
    }[];
}

Type declaration

[key: string]: {
    listener: Function;
    options?: ObservableListenerOpts;
    unbindkey: Listener;
}[]

Methods

fire

fire<K>(eventName, ...args): boolean
Fire an event

When a listener returns false this function will return false too.
Type Parameters
- K extends never
Parameters
- eventName: K
- Rest ...args: Parameters<ObservableEventMap<Observable>[K]>
Returns boolean
- Defined in component/Observable.ts:179

on

on<key, L>(eventName, listener, options?): L
Add a listener
Type Parameters
- key extends never
- L extends Listener<Observable>
Parameters
- eventName: never
- listener: ObservableEventMap<Observable>[key]
- Optional options: ObservableListenerOpts
Returns L
- Defined in component/Observable.ts:95

`Protected` onFirstListenerAdded

onFirstListenerAdded(eventName): void
Protected
Override this function to lazily initialize events
Parameters
- eventName: string
Returns void
- Defined in component/Observable.ts:133

`Private` once

once(eventName, listener): ((...args) => void)
Parameters
- eventName: never
- listener: Function
Returns ((...args) => void)
- - (...args): void
  - Parameters
    - Rest ...args: any[]
    Returns void
- Defined in component/Observable.ts:137

`Protected` relayEvent

relayEvent(comp, type): void
Parameters
- comp: Observable
- type: any
Returns void
- Defined in component/Observable.ts:199

un

un(eventName, listener): boolean
Remove listener
Parameters
- eventName: never
- listener: Function
Returns boolean
- Defined in component/Observable.ts:155

Generated using TypeDoc