A valid instance of type StoreDataT, serving as the initial value of the data.
An object describing which fields in the store data to persist in localStorage. The object consists of keys matching the keys in `StoreDataT´, with either a boolean value (true if the value should be persisted as standard JSON), or an object with custom serializer/deserializers for the field.
If given, will be used when storing state in LocalStorage. This allows an app to use more
than one ObservableStore without their values colliding.
Concats the given element to the list in field key, updating the value as per set
Updates the ObservableStore based on the current values in the store. This is useful if you need functionality
such as "add an item to an existing array in the store". (Remember that the store values should be treated as
immutable, so in this example, you should .concat rather than .push).
A function which takes the current data of the store and returns an object with a subset
(Pick) of the fields.
The calculated fields will be updated in the store, and any Observables will be triggered as if the values had
been set with set.
A DeepReadonly version of the result of the update function; i.e. the same object which has been set in the store.
Updates the ObservableStore based on the current values in the store.
A function which takes the current data of the store and returns an object with a subset
(Partial) of the fields. This is a looser typing than a Pick, in turn giving less information about the return
type. Also, if you do not use exactOptionalPropertyTypes: true, be careful not to break the types by explicitly
setting an undefined value in an optional field.
The calculated fields will be updated in the store, and any Observables will be triggered as if the values had
been set with set.
A DeepReadonly version of the result of the update function; i.e. the same object which has been set in the store.
Updates the ObservableStore asynchronously based on the current values in the store. This is useful if you need functionality
such as "add an item to an existing array in the store". (Remember that the store values should be treated as
immutable, so in this example, you should .concat rather than .push).
A function which takes the current data of the store and returns a Promise of a subset
(Pick) of the fields.
Once the Promise fulfills, the calculated fields will be updated in the store, and any Observables will
be triggered as if the values had been set with set.
A DeepReadonly version of the result of the update function; i.e. the same Promised object which will be set in the store.
Updates the ObservableStore asynchronously based on the current values in the store. This is useful if you need functionality
A function which takes the current data of the store and returns a Promise of a subset
(Partial) of the fields. This is a looser typing than a Pick, in turn giving less information about the return
type. Also, if you do not use exactOptionalPropertyTypes: true, be careful not to break the types by explicitly
setting an undefined value in an optional field.
Once the Promise fulfills, the calculated fields will be updated in the store, and any Observables will
be triggered as if the values had been set with set.
A DeepReadonly version of the result of the update function; i.e. the same Promised object which will be set in the store.
Angular-specific utility method binding a given FormControl(Like) to a key in the store. The FormControl will
be initialized with the current value in the store, and will then be kept in sync with the store, updating each
other as changes happen in one or the other.
The store key to bind to.
An Angular FormControl. It is assumed that the formControl values will be of the correct type
for the store.
A SubscriptionLike which must be used to unsubscribe the binding when the FormControl is disposed of.
Angular-specific utility method binding a given FormControl(Like) to a key in the store. The FormControl will
be initialized with the current value in the store, and will then be kept in sync with the store, updating each
other as changes happen in one or the other.
The store key to bind to.
An Angular FormControl. It is assumed that the formControl values will be of the correct type
for the store.
An Observable which signals when this binding should be disconnected. Typically, this will be an
Observable signaling when the Angular component is being destroyed.
Returns the current value of the internal data.
Returns an Observable which emits the values for the given key as they are updated.
If an observed field is of an object type, e.g. MyInterface, the returned value will be of utility type
DeepReadonly<MyInterface>. (If the returned object was not immutable, it would be possible to manipulate the
internal state of the ObservableStore by reference without triggering change notifications).
This is essentially a shorthand for
observableStore.pipe(
map(data => {
const o = data.key;
return o as DeepReadonly<typeof o>;
}),
distinctUntilChanged((a, b) => deepEquals(a, b))
);
Returns an Observable of an object consisting of the specified fields.
If an observed field is of an object type, e.g. MyInterface, the returned value will be of utility type
DeepReadonly<MyInterface>. (If the returned object was not immutable, it would be possible to manipulate the
internal state of the ObservableStore by reference without triggering change notifications).
This is essentially a shorthand for
observableStore.pipe(
map(data => {
const o = {
k1: data.k1,
k2: data.k2
};
return o as DeepReadonly<typeof o>;
}),
distinctUntilChanged((a, b) => deepEquals(a, b))
);
Returns an Observable of an object consisting of the specified fields, given as an array.
If an observed field is of an object type, e.g. MyInterface, the returned value will be of utility type
DeepReadonly<MyInterface>. (If the returned object was not immutable, it would be possible to manipulate the
internal state of the ObservableStore by reference without triggering change notifications).
This is equivalent to
observableStore.pipe(
map(data => {
const o = {
k1: data.k1,
k2: data.k2
};
return o as DeepReadonly<typeof o>;
}),
distinctUntilChanged((a, b) => deepEquals(a, b))
);
As observe, but instead of returning DeepReadonly objects, it returns a deep clone (using structuredClone). This means you're free to manipulate the returned object without violating the immutability of the ObservableStore.
As observe, but instead of returning DeepReadonly objects, it returns a deep clone (using structuredClone). This means you're free to manipulate the returned object without violating the immutability of the ObservableStore.
As observe, but instead of returning DeepReadonly objects, it returns a deep clone (using structuredClone). This means you're free to manipulate the returned object without violating the immutability of the ObservableStore.
As observe, but emits a tuple of [previous, current] values. previous will be undefined at the first
emit.
As observe, but emits a tuple of [previous, current] values. previous will be undefined at the first
emit.
As observe, but emits a tuple of [previous, current] values. previous will be undefined at the first
emit.
Sets a given field to a given value. If the new value is not equal to the current value, it will trigger a
notification in the relevant Observables. (See observe)
The name of the field. Must be a field in type StoreDataT
The new value. Must be of the appropriate type.
Sets several fields at once. If any of the new values are not equal to the current value, it will trigger a
notification in the relevant Observables. (See observe)
An object containing key/value pairs to set. The object must be a subset (Pick) of type StoreDataT
Angular-specific utility method which sets the given keys from a ParamMap-like object in the store, restricted to
only the keys which are of type number, string or undefined in the ObservableStore (since they are the types
which can reliably be expressed in the route without needing custom deserialization).
A ParamMaplike object, as obtained from Angular's ActivatedRoute.paramMap Observable.
The name of the keys to pick from the ParamMap and set in the ObservableStore.
An
ObservableStoremaintains data of generic typeStoreDataT, providing methods to set the fields, in turn emitting values on requestedObservables. The values are emitted as read-only objects to prevent manipulation of the internal data structure, though it is also possible to request a deep clone of the objects.The
ObservableStorecan write its state to LocalStorage, making it possible to easily recreate the application state when reloading the app.(The
ObservableStoreis itself anObservableof typeStoreDataT, acting like aBehaviorSubject, maintaining a single value and replaying it to new subscribers).