Class DebouncedObservable<T>

DebouncedObservable implements an Observerable that notifies in a debounced manner

Type Parameters

T

Hierarchy

Observable<T>
- DebouncedObservable

Index

Constructors

Properties

observers state

Accessors

Methods

notify subscribe unsubscribe

Constructors

constructor

new DebouncedObservable<T>(state: T, milliseconds: number): DebouncedObservable<T>
Type Parameters
- T
Parameters
- state: T
  
  the initial state
- milliseconds: number
  
  the milliseconds to debounce
Returns DebouncedObservable<T>
Overrides Observable.constructor
- Defined in index.ts:130

Properties

`Protected` observers

observers: ((state: T) => any)[] = []

`Protected` state

state: T

Accessors

value

get value(): T
Returns T
Inherited from Observable.value
- Defined in index.ts:74
set value(state: T): void
Parameters
- state: T
Returns void
Inherited from Observable.value
- Defined in index.ts:78

Methods

notify

notify(state: T): void
Parameters
- state: T
Returns void
Inherited from Observable.notify
- Defined in index.ts:88

subscribe

subscribe(observer: ((state: T) => any), options?: { immediate: boolean }): (() => void)
subscribe an observer to value changes

Returns
unsubscribe function for the given observer
Parameters
- observer: ((state: T) => any)
  
  the observer function to call upon value changes
  - - (state: T): any
    - Parameters
      
      state: T
      
      Returns any
- options: { immediate: boolean } = ...
  
  use with { immediate: true } to call the observer with the current state immediately
  - immediate: boolean
Returns (() => void)
- - (): void
  - subscribe an observer to value changes
    
    Returns
    unsubscribe function for the given observer
    
    Returns void
Inherited from Observable.subscribe
- Defined in index.ts:100

unsubscribe

unsubscribe(observer: ((state: T) => any)): void
unsubscribe the given observer from the observerable
Parameters
- observer: ((state: T) => any)
  
  the observer to unsubscribe
  - - (state: T): any
    - Parameters
      
      state: T
      
      Returns any
Returns void
Inherited from Observable.unsubscribe
- Defined in index.ts:114

Generated using TypeDoc