StoredValueSubject

An Observable BehaviorSubject that also wraps a value in web storage somewhere.

This value is also mute-able. When muted, the value won't change and won't report changes that come from the storage events.

Hierarchy

BehaviorSubject<StoredValue>
- StoredValueSubject

Implements

Subscribable<StoredValue>
ISubscription

Index

Modules

Observable

Constructors

constructor

Properties

Methods

Constructors

constructor

new StoredValueSubject(options: Options): StoredValueSubject

Overrides BehaviorSubject.__constructor
- Defined in index.ts:22
Parameters
- options: Options
Returns StoredValueSubject

Properties

_isScalar

_isScalar: boolean

closed

closed: boolean

hasError

hasError: boolean

isStopped

isStopped: boolean

Private key

key: string

Private muted

muted: boolean

observers

observers: Observer<StoredValue>[]

Protected operator

operator: Operator<any, StoredValue>

Protected source

source: Observable<any>

Private storage

storage: Storage

Private storage$

storage$: Observable<StoredValue>

Private subscriptions

subscriptions: Subscription[] = []

thrownError

thrownError: any

value

value: StoredValue

Static create

create: Function

Static filter

filter: filter

Static if

if: create

Static map

map: map

Static throw

throw: create

Methods

Protected _subscribe

_subscribe(subscriber: Subscriber<StoredValue>): Subscription

Inherited from BehaviorSubject._subscribe

Overrides Subject._subscribe
- Defined in C:/Users/Ryan/Documents/GitHub/hauda/node_modules/rxjs/BehaviorSubject.d.ts:11
Parameters
- subscriber: Subscriber<StoredValue>
Returns Subscription

Protected _trySubscribe

_trySubscribe(subscriber: Subscriber<StoredValue>): TeardownLogic

Inherited from Subject._trySubscribe

Overrides Observable._trySubscribe
- Defined in C:/Users/Ryan/Documents/GitHub/hauda/node_modules/rxjs/Subject.d.ts:29
Parameters
- subscriber: Subscriber<StoredValue>
Returns TeardownLogic

asObservable

asObservable(): Observable<StoredValue>

Inherited from Subject.asObservable
- Defined in C:/Users/Ryan/Documents/GitHub/hauda/node_modules/rxjs/Subject.d.ts:31
Returns Observable<StoredValue>

complete

complete(): void

Inherited from Subject.complete
- Defined in C:/Users/Ryan/Documents/GitHub/hauda/node_modules/rxjs/Subject.d.ts:27
Returns void

error

error(err: any): void

Inherited from Subject.error
- Defined in C:/Users/Ryan/Documents/GitHub/hauda/node_modules/rxjs/Subject.d.ts:26
Parameters
- err: any
Returns void

forEach

forEach(next: function, PromiseCtor?: undefined | PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in C:/Users/Ryan/Documents/GitHub/hauda/node_modules/rxjs/Observable.d.ts:58
method

forEach

Parameters
- next: function
  
  a handler for each value emitted by the observable
  - - (value: StoredValue): void
    - Parameters
      - value: StoredValue
      Returns void
- Optional PromiseCtor: undefined | PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

getValue

getValue(): StoredValue

Inherited from BehaviorSubject.getValue
- Defined in C:/Users/Ryan/Documents/GitHub/hauda/node_modules/rxjs/BehaviorSubject.d.ts:12
Returns StoredValue

Private getValueFromStorage

getValueFromStorage(): StoredValue

- Defined in index.ts:70
Returns StoredValue

lift

lift<R>(operator: Operator<StoredValue, R>): Observable<R>

Inherited from Subject.lift

Overrides Observable.lift
- Defined in C:/Users/Ryan/Documents/GitHub/hauda/node_modules/rxjs/Subject.d.ts:24
Type parameters
- R
Parameters
- operator: Operator<StoredValue, R>
Returns Observable<R>

mute

mute(): void

- Defined in index.ts:61
Returns void

next(value: StoredValue): void

Overrides BehaviorSubject.next
- Defined in index.ts:43
Put a stored value into storage and report the value to subscribers.

StoredValue => will set a new value in storage NoValue => Will remove the value from storage Unknown => Pushed to subscribers, but no side effects StorageError =>

Parameters
- value: StoredValue
Returns void

pipe

pipe(): Observable<StoredValue>
pipe<A>(op1: OperatorFunction<StoredValue, A>): Observable<A>
pipe<A, B>(op1: OperatorFunction<StoredValue, A>, op2: OperatorFunction<A, B>): Observable<B>
pipe<A, B, C>(op1: OperatorFunction<StoredValue, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>): Observable<C>
pipe<A, B, C, D>(op1: OperatorFunction<StoredValue, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>, op4: OperatorFunction<C, D>): Observable<D>
pipe<A, B, C, D, E>(op1: OperatorFunction<StoredValue, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>, op4: OperatorFunction<C, D>, op5: OperatorFunction<D, E>): Observable<E>
pipe<A, B, C, D, E, F>(op1: OperatorFunction<StoredValue, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>, op4: OperatorFunction<C, D>, op5: OperatorFunction<D, E>, op6: OperatorFunction<E, F>): Observable<F>
pipe<A, B, C, D, E, F, G>(op1: OperatorFunction<StoredValue, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>, op4: OperatorFunction<C, D>, op5: OperatorFunction<D, E>, op6: OperatorFunction<E, F>, op7: OperatorFunction<F, G>): Observable<G>
pipe<A, B, C, D, E, F, G, H>(op1: OperatorFunction<StoredValue, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>, op4: OperatorFunction<C, D>, op5: OperatorFunction<D, E>, op6: OperatorFunction<E, F>, op7: OperatorFunction<F, G>, op8: OperatorFunction<G, H>): Observable<H>
pipe<A, B, C, D, E, F, G, H, I>(op1: OperatorFunction<StoredValue, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>, op4: OperatorFunction<C, D>, op5: OperatorFunction<D, E>, op6: OperatorFunction<E, F>, op7: OperatorFunction<F, G>, op8: OperatorFunction<G, H>, op9: OperatorFunction<H, I>): Observable<I>

Inherited from Observable.pipe
- Defined in C:/Users/Ryan/Documents/GitHub/hauda/node_modules/rxjs/Observable.d.ts:62
Returns Observable<StoredValue>
Inherited from Observable.pipe
- Defined in C:/Users/Ryan/Documents/GitHub/hauda/node_modules/rxjs/Observable.d.ts:63
Type parameters
- A
Parameters
- op1: OperatorFunction<StoredValue, A>
Returns Observable<A>
Inherited from Observable.pipe
- Defined in C:/Users/Ryan/Documents/GitHub/hauda/node_modules/rxjs/Observable.d.ts:64
Type parameters
- A
- B
Parameters
- op1: OperatorFunction<StoredValue, A>
- op2: OperatorFunction<A, B>
Returns Observable<B>
Inherited from Observable.pipe
- Defined in C:/Users/Ryan/Documents/GitHub/hauda/node_modules/rxjs/Observable.d.ts:65
Type parameters
- A
- B
- C
Parameters
- op1: OperatorFunction<StoredValue, A>
- op2: OperatorFunction<A, B>
- op3: OperatorFunction<B, C>
Returns Observable<C>
Inherited from Observable.pipe
- Defined in C:/Users/Ryan/Documents/GitHub/hauda/node_modules/rxjs/Observable.d.ts:66
Type parameters
- A
- B
- C
- D
Parameters
- op1: OperatorFunction<StoredValue, A>
- op2: OperatorFunction<A, B>
- op3: OperatorFunction<B, C>
- op4: OperatorFunction<C, D>
Returns Observable<D>
Inherited from Observable.pipe
- Defined in C:/Users/Ryan/Documents/GitHub/hauda/node_modules/rxjs/Observable.d.ts:67
Type parameters
- A
- B
- C
- D
- E
Parameters
- op1: OperatorFunction<StoredValue, A>
- op2: OperatorFunction<A, B>
- op3: OperatorFunction<B, C>
- op4: OperatorFunction<C, D>
- op5: OperatorFunction<D, E>
Returns Observable<E>
Inherited from Observable.pipe
- Defined in C:/Users/Ryan/Documents/GitHub/hauda/node_modules/rxjs/Observable.d.ts:68
Type parameters
- A
- B
- C
- D
- E
- F
Parameters
- op1: OperatorFunction<StoredValue, A>
- op2: OperatorFunction<A, B>
- op3: OperatorFunction<B, C>
- op4: OperatorFunction<C, D>
- op5: OperatorFunction<D, E>
- op6: OperatorFunction<E, F>
Returns Observable<F>
Inherited from Observable.pipe
- Defined in C:/Users/Ryan/Documents/GitHub/hauda/node_modules/rxjs/Observable.d.ts:69
Type parameters
- A
- B
- C
- D
- E
- F
- G
Parameters
- op1: OperatorFunction<StoredValue, A>
- op2: OperatorFunction<A, B>
- op3: OperatorFunction<B, C>
- op4: OperatorFunction<C, D>
- op5: OperatorFunction<D, E>
- op6: OperatorFunction<E, F>
- op7: OperatorFunction<F, G>
Returns Observable<G>
Inherited from Observable.pipe
- Defined in C:/Users/Ryan/Documents/GitHub/hauda/node_modules/rxjs/Observable.d.ts:70
Type parameters
- A
- B
- C
- D
- E
- F
- G
- H
Parameters
- op1: OperatorFunction<StoredValue, A>
- op2: OperatorFunction<A, B>
- op3: OperatorFunction<B, C>
- op4: OperatorFunction<C, D>
- op5: OperatorFunction<D, E>
- op6: OperatorFunction<E, F>
- op7: OperatorFunction<F, G>
- op8: OperatorFunction<G, H>
Returns Observable<H>
Inherited from Observable.pipe
- Defined in C:/Users/Ryan/Documents/GitHub/hauda/node_modules/rxjs/Observable.d.ts:71
Type parameters
- A
- B
- C
- D
- E
- F
- G
- H
- I
Parameters
- op1: OperatorFunction<StoredValue, A>
- op2: OperatorFunction<A, B>
- op3: OperatorFunction<B, C>
- op4: OperatorFunction<C, D>
- op5: OperatorFunction<D, E>
- op6: OperatorFunction<E, F>
- op7: OperatorFunction<F, G>
- op8: OperatorFunction<G, H>
- op9: OperatorFunction<H, I>
Returns Observable<I>

Private storageStream

storageStream(): Observable<StoredValue>

- Defined in index.ts:76
Returns Observable<StoredValue>

subscribe(observer?: PartialObserver<StoredValue>): Subscription
subscribe(next?: undefined | function, error?: undefined | function, complete?: undefined | function): Subscription

Inherited from Observable.subscribe
- Defined in C:/Users/Ryan/Documents/GitHub/hauda/node_modules/rxjs/Observable.d.ts:48
Parameters
- Optional observer: PartialObserver<StoredValue>
Returns Subscription
Inherited from Observable.subscribe
- Defined in C:/Users/Ryan/Documents/GitHub/hauda/node_modules/rxjs/Observable.d.ts:49
Parameters
- Optional next: undefined | function
- Optional error: undefined | function
- Optional complete: undefined | function
Returns Subscription

toPromise

toPromise<T>(this: Observable<T>): Promise<T>
toPromise<T>(this: Observable<T>, PromiseCtor: PromiseConstructor): Promise<T>
toPromise<T>(this: Observable<T>, PromiseCtor: PromiseConstructorLike): Promise<T>

Inherited from Observable.toPromise
- Defined in C:/Users/Ryan/Documents/GitHub/hauda/node_modules/rxjs/Observable.d.ts:72
Type parameters
- T
Parameters
- this: Observable<T>
Returns Promise<T>
Inherited from Observable.toPromise
- Defined in C:/Users/Ryan/Documents/GitHub/hauda/node_modules/rxjs/Observable.d.ts:73
Type parameters
- T
Parameters
- this: Observable<T>
- PromiseCtor: PromiseConstructor
Returns Promise<T>
Inherited from Observable.toPromise
- Defined in C:/Users/Ryan/Documents/GitHub/hauda/node_modules/rxjs/Observable.d.ts:74
Type parameters
- T
Parameters
- this: Observable<T>
- PromiseCtor: PromiseConstructorLike
Returns Promise<T>

unmute

unmute(): void

- Defined in index.ts:65
Returns void

unsubscribe

unsubscribe(): void

Overrides Subject.unsubscribe
- Defined in index.ts:56
Returns void

Private writeValue

writeValue(value: StoredValue): void

- Defined in index.ts:84
Parameters
- value: StoredValue
Returns void

Generated using TypeDoc

Hierarchy

Implements

Index

Modules

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: Options

Returns StoredValueSubject

Properties

_isScalar

closed

hasError

isStopped

Private key

Private muted

observers

Protected operator

Protected source

Private storage

Private storage$

Private subscriptions

thrownError

value

Static create

Static filter

Static if

Static map

Static throw

Methods

Protected _subscribe

Parameters

subscriber: Subscriber<StoredValue>

Returns Subscription

Protected _trySubscribe

Parameters

subscriber: Subscriber<StoredValue>

Returns TeardownLogic

asObservable

Returns Observable<StoredValue>

complete

Returns void

error

Parameters

err: any

Returns void

forEach

Parameters

next: function

Parameters

value: StoredValue

Returns void

Optional PromiseCtor: undefined | PromiseConstructor

Returns Promise<void>

getValue

Returns StoredValue

Private getValueFromStorage

Returns StoredValue

lift

Type parameters

R

Parameters

operator: Operator<StoredValue, R>

Returns Observable<R>

mute

Returns void

next

Parameters

value: StoredValue

Returns void

pipe

Returns Observable<StoredValue>

Type parameters

A

Parameters

op1: OperatorFunction<StoredValue, A>

Returns Observable<A>