External module "src/modules/state/stateOf"

Index

Type aliases

Functions

Type aliases

ObservableLike

ObservableLike<T>: StateObservable<T> | Observable<T>

Either StateObservable or [[Observable]]

Type parameters

T

StateObservable

StateObservable<T, U>: keyof [Observable<U>, function, function]

Similar to the what React's useState hook returns but for observables. It's a thruple containing:

0: A stateful observable (see RxJS' BehaviourSubject)
1: A function to update/set the state ($.next(..))
1. A get state function. ($.getValue())

Type parameters

T
U

Functions

Const isStateObservable

isStateObservable<T>(observable$: ObservableLike<T>): boolean

- Defined in src/modules/state/stateOf.ts:27
```
isStateObservable :: ObservableLike a -> boolean
```
Determines if the given observable like value is a StateObservable
Type parameters
- T
Parameters
- observable$: ObservableLike<T>
Returns boolean

Const stateOf

stateOf<T>(initialState: T): StateObservable<T>

- Defined in src/modules/state/stateOf.ts:40
```
stateOf :: a -> StateObservable a
```
Create a stateful observable. Uses RxJS' BehaviourSubject under the hood.
Type parameters
- T
  
  Type describing the type of the data stored.
Parameters
- initialState: T
  
  Initial state of the observable (see [[BehaviourSubject]])
Returns StateObservable<T>

Generated using TypeDoc