Store | @bytesoftio/store

Type parameters

TValue: object

Hierarchy

Store

Implements

ObservableStore<TValue>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Store(initialValue: TValue, merger?: StoreMerger<TValue>, differ?: StoreDiffer<TValue>): Store

- Defined in Store.ts:20
Parameters
- initialValue: TValue
- Default value merger: StoreMerger<TValue> = defaultMerger
- Default value differ: StoreDiffer<TValue> = defaultDiffer
Returns Store

Properties

differ

differ: StoreDiffer<any>

initialValue

initialValue: TValue

listeners

listeners: StoreListener<TValue, any>[]

merger

merger: StoreMerger<TValue>

value

value: TValue

Methods

add

add(newValue: Partial<TValue>): void

Implementation of ObservableStore.add
- Defined in Store.ts:47
Parameters
- newValue: Partial<TValue>
Returns void

get

get(): TValue

Implementation of ObservableStore.get
- Defined in Store.ts:34
Returns TValue

listen

listen<TValueMapped>(callback: StoreCallback<TValueMapped>, notifyImmediately?: boolean, mapper?: StoreMapper<TValue, TValueMapped>): StoreCallbackUnsubscribe

- Defined in Store.ts:61
Type parameters
- TValueMapped: object
Parameters
- callback: StoreCallback<TValueMapped>
- Default value notifyImmediately: boolean = true
- Optional mapper: StoreMapper<TValue, TValueMapped>
Returns StoreCallbackUnsubscribe

Protected notify

notify(): void

- Defined in Store.ts:76
Returns void

reset

reset(initialValue?: TValue): void

Implementation of ObservableStore.reset
- Defined in Store.ts:53
Parameters
- Optional initialValue: TValue
Returns void

set

set(newValue: TValue): void

Implementation of ObservableStore.set
- Defined in Store.ts:38
Parameters
- newValue: TValue
Returns void