store


Installation

``
npm install @flexbase/store
`

or

`
yarn add @flexbase/store
`

Concepts

The concept behind the store is to separate state management from other application concerns. It is Promise based utilizing an Observer pattern.

Usage

Example data

`ts
interface SomeData {
name: string;
id: number;
}
`

$3

`ts
const someDataStore = createStore();

const someOtherStore = createStore();
`

#### Create Store Options

`ts
// object style
const someDataStore = createStore({
key?: symbol, // use the specified key to represent this store; otherwise Symbol() is used
defaultValue?: , // use the specified value as the default value
comparer?: StoreComparer, // use the specified comparer; otherwise defaultStoreComparer is used
middleware?: StoreMiddleware[], // use the specified middleware(s)
persistanceProvider?: PersistanceProvider, // use the specified persistance provider
storageManager: StorageManager // use the specified storage manager; otherwise use the global manager
});

// fluent style
const someDataStore = createStore(options => {
options
.key(key: symbol | string) // use the specified key to represent this store; otherwise Symbol() is used
.defaultValue(value: ) // use the specified value as the default value
.comparer(comparer: StoreComparer) // use the specified comparer; otherwise defaultStoreComparer is used
.middleware(...middleware: StoreMiddleware[]) // use the specified middleware(s)
.persistanceProvider(persistanceProvider: PersistanceProvider) // use the specified persistance provider
.storageManager(storageManager: StorageManager) // use the specified storage manager; otherwise use the global manager
});
`

$3

`ts
const value = getStoreValue(someDataStore);
`

$3

`ts
await setStoreValue(someDataStore, { name: 'Test', id: 1 });

await setStoreValue(someOtherStore, 42);
`

#### Using a callback

`ts
await setStoreValue(someDataStore, _ => {name: 'Test', id: 1});

await setStoreValue(someOtherStore, _ => 42);

// do more in the callback
await setStoreValue(test, currentValue => (currentValue ? Math.min(42, currentValue) : 0));
`

$3

`ts
let value: number;

const numberStore = createStore({ defaultValue: 42 });

value = storageManager.getValue(numberStore); // value is 42

await storageManager.setValue(numberStore, 1);

value = storageManager.getValue(numberStore); // value is 1

await resetStoreValue(numberStore);

value = storageManager.getValue(numberStore); // value is 42
`

$3

`ts
const setter = getStoreSetter(someDataStore);

await setter({ name: 'Test', id: 1 });

await setter(_ => {name: 'Test', id: 1});

`

$3

`ts
const subscription = subscribeToStore(someDataStore, context => {...});

subscription.unsubscribe();
``

Persistance

TODO

Middleware

TODO