Store | @spicy-hooks v2.1.2

Base class for every RxJS store.

Type parameters

T

type of the store's state

Hierarchy

BehaviorSubject<T>
- Store

Implements

Subscribable<T>
SubscriptionLike
UpdatableSubscribable<T>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Store(_value: T): Store

Inherited from Store.constructor

Overrides Subject.__constructor
- Defined in node_modules/rxjs/internal/BehaviorSubject.d.ts:11
Parameters
- _value: T
Returns Store

Properties

_isScalar

_isScalar: boolean

Internal implementation detail, do not use directly.

closed

closed: boolean

hasError

hasError: boolean

isStopped

isStopped: boolean

observers

observers: Observer<T>[]

operator

operator: Operator<any, T>

deprecated: This is an internal implementation detail, do not use.

source

source: Observable<any>

deprecated: This is an internal implementation detail, do not use.

thrownError

thrownError: any

value

value: T

Static create

create: Function

nocollapse
deprecated: use new Subject() instead

Static if

if: typeof iif

nocollapse
deprecated: In favor of iif creation function: import { iif } from 'rxjs';

Static throw

throw: typeof throwError

nocollapse
deprecated: In favor of throwError creation function: import { throwError } from 'rxjs';

Methods

_subscribe

_subscribe(subscriber: Subscriber<T>): Subscription

Inherited from Store._subscribe

Overrides Subject._subscribe
- Defined in node_modules/rxjs/internal/BehaviorSubject.d.ts:15
deprecated

This is an internal implementation detail, do not use.

Parameters
- subscriber: Subscriber<T>
Returns Subscription

_trySubscribe

_trySubscribe(subscriber: Subscriber<T>): TeardownLogic

Inherited from Store._trySubscribe

Overrides Observable._trySubscribe
- Defined in node_modules/rxjs/internal/Subject.d.ts:39
deprecated

This is an internal implementation detail, do not use.

Parameters
- subscriber: Subscriber<T>
Returns TeardownLogic

asObservable

asObservable(): Observable<T>

Inherited from Store.asObservable
- Defined in node_modules/rxjs/internal/Subject.d.ts:48
Creates a new Observable with this Subject as the source. You can do this to create customize Observer-side logic of the Subject and conceal it from code that uses the Observable.

Returns Observable<T>

Observable that the Subject casts to

complete

complete(): void

Inherited from Store.complete
- Defined in node_modules/rxjs/internal/Subject.d.ts:36
Returns void

error

error(err: any): void

Inherited from Store.error
- Defined in node_modules/rxjs/internal/Subject.d.ts:35
Parameters
- err: any
Returns void

forEach

forEach(next: (value: T) => void, promiseCtor?: PromiseConstructorLike): Promise<void>

Inherited from Store.forEach
- Defined in node_modules/rxjs/internal/Observable.d.ts:64
method

forEach

Parameters
- next: (value: T) => void
  
  a handler for each value emitted by the observable
  - - (value: T): void
    - Parameters
      - value: T
      Returns void
- Optional promiseCtor: PromiseConstructorLike
Returns Promise<void>

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

getValue

getValue(): T

Inherited from Store.getValue
- Defined in node_modules/rxjs/internal/BehaviorSubject.d.ts:16
Returns T

lift

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

Inherited from Store.lift

Overrides Observable.lift
- Defined in node_modules/rxjs/internal/Subject.d.ts:33
Type parameters
- R
Parameters
- operator: Operator<T, R>
Returns Observable<R>

next(value: T): void

Inherited from Store.next

Overrides Subject.next
- Defined in node_modules/rxjs/internal/BehaviorSubject.d.ts:17
Parameters
- value: T
Returns void

pipe

pipe(): Observable<T>
pipe<A>(op1: OperatorFunction<T, A>): Observable<A>
pipe<A, B>(op1: OperatorFunction<T, A>, op2: OperatorFunction<A, B>): Observable<B>
pipe<A, B, C>(op1: OperatorFunction<T, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>): Observable<C>
pipe<A, B, C, D>(op1: OperatorFunction<T, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>, op4: OperatorFunction<C, D>): Observable<D>
pipe<A, B, C, D, E>(op1: OperatorFunction<T, 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<T, 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<T, 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<T, 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<T, 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>
pipe<A, B, C, D, E, F, G, H, I>(op1: OperatorFunction<T, 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>, ...operations: OperatorFunction<any, any>[]): Observable<{}>

Inherited from Store.pipe
- Defined in node_modules/rxjs/internal/Observable.d.ts:77
Returns Observable<T>
Inherited from Store.pipe
- Defined in node_modules/rxjs/internal/Observable.d.ts:78
Type parameters
- A
Parameters
- op1: OperatorFunction<T, A>
Returns Observable<A>
Inherited from Store.pipe
- Defined in node_modules/rxjs/internal/Observable.d.ts:79
Type parameters
- A
- B
Parameters
- op1: OperatorFunction<T, A>
- op2: OperatorFunction<A, B>
Returns Observable<B>
Inherited from Store.pipe
- Defined in node_modules/rxjs/internal/Observable.d.ts:80
Type parameters
- A
- B
- C
Parameters
- op1: OperatorFunction<T, A>
- op2: OperatorFunction<A, B>
- op3: OperatorFunction<B, C>
Returns Observable<C>
Inherited from Store.pipe
- Defined in node_modules/rxjs/internal/Observable.d.ts:81
Type parameters
- A
- B
- C
- D
Parameters
- op1: OperatorFunction<T, A>
- op2: OperatorFunction<A, B>
- op3: OperatorFunction<B, C>
- op4: OperatorFunction<C, D>
Returns Observable<D>
Inherited from Store.pipe
- Defined in node_modules/rxjs/internal/Observable.d.ts:82
Type parameters
- A
- B
- C
- D
- E
Parameters
- op1: OperatorFunction<T, A>
- op2: OperatorFunction<A, B>
- op3: OperatorFunction<B, C>
- op4: OperatorFunction<C, D>
- op5: OperatorFunction<D, E>
Returns Observable<E>
Inherited from Store.pipe
- Defined in node_modules/rxjs/internal/Observable.d.ts:83
Type parameters
- A
- B
- C
- D
- E
- F
Parameters
- op1: OperatorFunction<T, 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 Store.pipe
- Defined in node_modules/rxjs/internal/Observable.d.ts:84
Type parameters
- A
- B
- C
- D
- E
- F
- G
Parameters
- op1: OperatorFunction<T, 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 Store.pipe
- Defined in node_modules/rxjs/internal/Observable.d.ts:85
Type parameters
- A
- B
- C
- D
- E
- F
- G
- H
Parameters
- op1: OperatorFunction<T, 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 Store.pipe
- Defined in node_modules/rxjs/internal/Observable.d.ts:86
Type parameters
- A
- B
- C
- D
- E
- F
- G
- H
- I
Parameters
- op1: OperatorFunction<T, 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>
Inherited from Store.pipe
- Defined in node_modules/rxjs/internal/Observable.d.ts:87
Type parameters
- A
- B
- C
- D
- E
- F
- G
- H
- I
Parameters
- op1: OperatorFunction<T, 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>
- Rest ...operations: OperatorFunction<any, any>[]
Returns Observable<{}>

subscribe(observer?: PartialObserver<T>): Subscription
subscribe(next: null | undefined, error: null | undefined, complete: () => void): Subscription
subscribe(next: null | undefined, error: (error: any) => void, complete?: undefined | (() => void)): Subscription
subscribe(next: (value: T) => void, error: null | undefined, complete: () => void): Subscription
subscribe(next?: undefined | ((value: T) => void), error?: undefined | ((error: any) => void), complete?: undefined | (() => void)): Subscription

Inherited from Store.subscribe
- Defined in node_modules/rxjs/internal/Observable.d.ts:47
Parameters
- Optional observer: PartialObserver<T>
Returns Subscription
Inherited from Store.subscribe
- Defined in node_modules/rxjs/internal/Observable.d.ts:49
deprecated

Use an observer instead of a complete callback

Parameters
- next: null | undefined
- error: null | undefined
- complete: () => void
  - - (): void
    - Returns void
Returns Subscription
Inherited from Store.subscribe
- Defined in node_modules/rxjs/internal/Observable.d.ts:51
deprecated

Use an observer instead of an error callback

Parameters
- next: null | undefined
- error: (error: any) => void
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: undefined | (() => void)
Returns Subscription
Inherited from Store.subscribe
- Defined in node_modules/rxjs/internal/Observable.d.ts:53
deprecated

Use an observer instead of a complete callback

Parameters
- next: (value: T) => void
  - - (value: T): void
    - Parameters
      - value: T
      Returns void
- error: null | undefined
- complete: () => void
  - - (): void
    - Returns void
Returns Subscription
Inherited from Store.subscribe
- Defined in node_modules/rxjs/internal/Observable.d.ts:54
Parameters
- Optional next: undefined | ((value: T) => void)
- Optional error: undefined | ((error: any) => void)
- Optional complete: undefined | (() => void)
Returns Subscription

toPromise

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

Inherited from Store.toPromise
- Defined in node_modules/rxjs/internal/Observable.d.ts:88
Type parameters
- T
Parameters
- this: Observable<T>
Returns Promise<T>
Inherited from Store.toPromise
- Defined in node_modules/rxjs/internal/Observable.d.ts:89
Type parameters
- T
Parameters
- this: Observable<T>
- PromiseCtor: typeof Promise
Returns Promise<T>
Inherited from Store.toPromise
- Defined in node_modules/rxjs/internal/Observable.d.ts:90
Type parameters
- T
Parameters
- this: Observable<T>
- PromiseCtor: PromiseConstructorLike
Returns Promise<T>

unsubscribe

unsubscribe(): void

Inherited from Store.unsubscribe
- Defined in node_modules/rxjs/internal/Subject.d.ts:37
Returns void

update

update(updater: (prev: T) => T): T

- Defined in packages/observables/src/internal/concepts/store.ts:22
inheritdoc

Parameters
- updater: (prev: T) => T
  - - (prev: T): T
    - Parameters
      - prev: T
      Returns T
Returns T

Generated using TypeDoc

Type parameters

T

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

_value: T

Returns Store

Properties

_isScalar

closed

hasError

isStopped

observers

operator

source

thrownError

value

Static create

Static if

Static throw

Methods

_subscribe

Parameters

subscriber: Subscriber<T>

Returns Subscription

_trySubscribe

Parameters

subscriber: Subscriber<T>

Returns TeardownLogic

asObservable

Returns Observable<T>

complete

Returns void

error

Parameters

err: any

Returns void

forEach

Parameters

next: (value: T) => void

Parameters

value: T

Returns void

Optional promiseCtor: PromiseConstructorLike

Returns Promise<void>

getValue

Returns T

lift

Type parameters

R

Parameters

operator: Operator<T, R>

Returns Observable<R>

next

Parameters

value: T

Returns void

pipe

Returns Observable<T>

Type parameters

A

Parameters

op1: OperatorFunction<T, A>

Returns Observable<A>

Type parameters

A

B

Parameters

op1: OperatorFunction<T, A>

op2: OperatorFunction<A, B>

Returns Observable<B>

Type parameters

A

B