Class DerivedStore<T, S>Abstract
Type Parameters
T
S extends StoresInput = StoresInput
Hierarchy (view full)
Index
Constructors
Methods
Constructors
constructor
- new
Derived Store<T, S>(stores, initialValue): DerivedStore<T, S> Type Parameters
T
S extends StoresInput = StoresInput
Returns DerivedStore<T, S>
Methods
[observable]
Protected Abstract derive
- derive(values): void | Unsubscriber
Parameters
values: StoresInputValues<S>
Returns void | Unsubscriber
Protected equal
- equal(a, b): boolean
Compares two values and returns true if they are equal. +
DerivedStore | @amadeus-it-group/tansu diff --git a/classes/Store.html b/classes/Store.html index 2ca3ebb..d37b933 100644 --- a/classes/Store.html +++ b/classes/Store.html @@ -1,64 +1,55 @@ -Class DerivedStore<T, S>
AbstractBase class that can be extended to easily create a custom Readable store.
+Example
+ +class CounterStore extends Store {
constructor() {
super(1); // initial value
}
reset() {
this.set(0);
}
increment() {
this.update(value => value + 1);
}
}
const store = new CounterStore(1);
// logs 1 (initial value) upon subscription
const unsubscribe = store.subscribe((value) => {
console.log(value);
});
store.increment(); // logs 2
store.reset(); // logs 0
unsubscribe(); // stops notifications and corresponding logging +Type Parameters
- T
- S extends StoresInput = StoresInput
Hierarchy (view full)
Index
Constructors
Methods
Constructors
constructor
- new
Derived Store<T, S>(stores, initialValue): DerivedStore<T, S> Type Parameters
- T
- S extends StoresInput = StoresInput
Returns DerivedStore<T, S>
Methods
[observable]
ProtectedAbstractderive- derive(values): void | Unsubscriber
Parameters
- values: StoresInputValues<S>
Returns void | Unsubscriber
Protectedequal- equal(a, b): boolean
Compares two values and returns true if they are equal. It is called when setting a new value to avoid doing anything (such as notifying subscribers) if the value did not change. The default logic is to return false if
-ais a function or an object, or ifaandbare different according toObject.is. This method can be overridden by subclasses to change the logic.Parameters
a: T
First value to compare.
-b: T
Second value to compare.
+Returns boolean
true if a and b are considered equal.
-Remarks
For backward compatibility, the default implementation calls the +
Remarks
For backward compatibility, the default implementation calls the deprecated Store.notEqual method and returns the negation of its return value.
-ProtectednotEqual get
ProtectednotEqual - not
Equal(a, b): boolean Compares two values and returns true if they are different. It is called when setting a new value to avoid doing anything (such as notifying subscribers) if the value did not change. The default logic is to return true if
-ais a function or an object, or ifaandbare different according toObject.is. This method can be overridden by subclasses to change the logic.Parameters
a: T
First value to compare.
-b: T
Second value to compare.
+Returns boolean
true if a and b are considered different.
-Remarks
This method is only called by the default implementation of +
Remarks
This method is only called by the default implementation of Store.equal, so overriding Store.equal takes precedence over overriding notEqual.
-Deprecated
Use Store.equal instead
-ProtectedonUse - on
Use(): void | Unsubscriber Function called when the number of subscribers changes from 0 to 1 +
Deprecated
Use Store.equal instead
+
ProtectedOptionalonUse - on
Use(): void | Unsubscriber Function called when the number of subscribers changes from 0 to 1 (but not called when the number of subscribers changes from 1 to 2, ...). If a function is returned, it will be called when the number of subscribers changes from 1 to 0.
-Returns void | Unsubscriber
Example
-class CustomStore extends Store {
onUse() {
console.log('Got the fist subscriber!');
return () => {
console.log('All subscribers are gone...');
};
}
}
const store = new CustomStore();
const unsubscribe1 = store.subscribe(() => {}); // logs 'Got the fist subscriber!'
const unsubscribe2 = store.subscribe(() => {}); // nothing is logged as we've got one subscriber already
unsubscribe1(); // nothing is logged as we still have one subscriber
unsubscribe2(); // logs 'All subscribers are gone...' -
ProtectedpauseSubscribers - pause
Subscribers(): void Puts the store in the paused state, which means it will soon update its value.
-Returns void
Remarks
The paused state prevents derived or computed stores (both direct and transitive) from recomputing their value -using the current value of this store.
-There are two ways to put a store back into its normal state: calling set to set a new -value or calling resumeSubscribers to declare that finally the value does not need to be -changed.
-Note that a store should not stay in the paused state for a long time, and most of the time -it is not needed to call pauseSubscribers or resumeSubscribers manually.
-
ProtectedresumeSubscribers - resume
Subscribers(): void Puts the store back to the normal state without changing its value, if it was in the paused state -(cf pauseSubscribers).
-Returns void
Remarks
Does nothing if the store was not in the paused state.
-
Protectedset- set(value): void
Replaces store's state with the provided value. +
Returns void | Unsubscriber
Example
+ +class CustomStore extends Store {
onUse() {
console.log('Got the fist subscriber!');
return () => {
console.log('All subscribers are gone...');
};
}
}
const store = new CustomStore();
const unsubscribe1 = store.subscribe(() => {}); // logs 'Got the fist subscriber!'
const unsubscribe2 = store.subscribe(() => {}); // nothing is logged as we've got one subscriber already
unsubscribe1(); // nothing is logged as we still have one subscriber
unsubscribe2(); // logs 'All subscribers are gone...' +
Protectedset- set(value): void
Replaces store's state with the provided value. Equivalent of Writable.set, but internal to the store.
-Parameters
value: T
value to be used as the new state of a store.
-
Returns void
subscribe
- subscribe(subscriber): UnsubscribeFunction & UnsubscribeObject
Default Implementation of the SubscribableStore.subscribe, not meant to be overridden.
-Parameters
subscriber: Subscriber<T>
Returns UnsubscribeFunction & UnsubscribeObject
Protectedupdatesubscribe
- subscribe(subscriber): UnsubscribeFunction & UnsubscribeObject
Default Implementation of the SubscribableStore.subscribe, not meant to be overridden.
+Parameters
- subscriber: Subscriber<T>
Returns UnsubscribeFunction & UnsubscribeObject
Protectedupdate- update(updater): void
Updates store's state by using an Updater function. Equivalent of Writable.update, but internal to the store.
-Parameters
Returns void
- on
\ No newline at end of file +Generated using TypeDoc
Parameters
Returns void
- not
Store | @amadeus-it-group/tansu Class Store<T>
AbstractBase class that can be extended to easily create a custom Readable store.
-Example
-class CounterStore extends Store {
constructor() {
super(1); // initial value
}
reset() {
this.set(0);
}
increment() {
this.update(value => value + 1);
}
}
const store = new CounterStore(1);
// logs 1 (initial value) upon subscription
const unsubscribe = store.subscribe((value) => {
console.log(value);
});
store.increment(); // logs 2
store.reset(); // logs 0
unsubscribe(); // stops notifications and corresponding logging -Type Parameters
Hierarchy (view full)
- Store
Implements
Index
Constructors
Methods
Constructors
constructor
Methods
[observable]
Protectedequal- equal(a, b): boolean
Compares two values and returns true if they are equal. +
Store | @amadeus-it-group/tansu diff --git a/functions/asReadable.html b/functions/asReadable.html index 6f86acc..967ce28 100644 --- a/functions/asReadable.html +++ b/functions/asReadable.html @@ -1,10 +1,10 @@ -Class Store<T>
AbstractBase class that can be extended to easily create a custom Readable store.
+Example
+ +class CounterStore extends Store {
constructor() {
super(1); // initial value
}
reset() {
this.set(0);
}
increment() {
this.update(value => value + 1);
}
}
const store = new CounterStore(1);
// logs 1 (initial value) upon subscription
const unsubscribe = store.subscribe((value) => {
console.log(value);
});
store.increment(); // logs 2
store.reset(); // logs 0
unsubscribe(); // stops notifications and corresponding logging +Type Parameters
Hierarchy (view full)
- Store
Implements
Index
Constructors
Methods
Methods
[observable]
Protectedequal- equal(a, b): boolean
Compares two values and returns true if they are equal. It is called when setting a new value to avoid doing anything (such as notifying subscribers) if the value did not change. The default logic is to return false if
-ais a function or an object, or ifaandbare different according toObject.is. This method can be overridden by subclasses to change the logic.Parameters
a: T
First value to compare.
-b: T
Second value to compare.
+Returns boolean
true if a and b are considered equal.
-Remarks
For backward compatibility, the default implementation calls the +
Remarks
For backward compatibility, the default implementation calls the deprecated Store.notEqual method and returns the negation of its return value.
-ProtectednotEqual get
ProtectednotEqual - not
Equal(a, b): boolean Compares two values and returns true if they are different. It is called when setting a new value to avoid doing anything (such as notifying subscribers) if the value did not change. The default logic is to return true if
-ais a function or an object, or ifaandbare different according toObject.is. This method can be overridden by subclasses to change the logic.Parameters
a: T
First value to compare.
-b: T
Second value to compare.
+Returns boolean
true if a and b are considered different.
-Remarks
This method is only called by the default implementation of +
Remarks
This method is only called by the default implementation of Store.equal, so overriding Store.equal takes precedence over overriding notEqual.
-Deprecated
Use Store.equal instead
-ProtectedonUse - on
Use(): void | Unsubscriber Function called when the number of subscribers changes from 0 to 1 +
Deprecated
Use Store.equal instead
+
ProtectedOptionalonUse - on
Use(): void | Unsubscriber Function called when the number of subscribers changes from 0 to 1 (but not called when the number of subscribers changes from 1 to 2, ...). If a function is returned, it will be called when the number of subscribers changes from 1 to 0.
-Returns void | Unsubscriber
Example
-class CustomStore extends Store {
onUse() {
console.log('Got the fist subscriber!');
return () => {
console.log('All subscribers are gone...');
};
}
}
const store = new CustomStore();
const unsubscribe1 = store.subscribe(() => {}); // logs 'Got the fist subscriber!'
const unsubscribe2 = store.subscribe(() => {}); // nothing is logged as we've got one subscriber already
unsubscribe1(); // nothing is logged as we still have one subscriber
unsubscribe2(); // logs 'All subscribers are gone...' -
ProtectedpauseSubscribers - pause
Subscribers(): void Puts the store in the paused state, which means it will soon update its value.
-Returns void
Remarks
The paused state prevents derived or computed stores (both direct and transitive) from recomputing their value -using the current value of this store.
-There are two ways to put a store back into its normal state: calling set to set a new -value or calling resumeSubscribers to declare that finally the value does not need to be -changed.
-Note that a store should not stay in the paused state for a long time, and most of the time -it is not needed to call pauseSubscribers or resumeSubscribers manually.
-
ProtectedresumeSubscribers - resume
Subscribers(): void Puts the store back to the normal state without changing its value, if it was in the paused state -(cf pauseSubscribers).
-Returns void
Remarks
Does nothing if the store was not in the paused state.
-
Protectedset- set(value): void
Replaces store's state with the provided value. +
Returns void | Unsubscriber
Example
+ +class CustomStore extends Store {
onUse() {
console.log('Got the fist subscriber!');
return () => {
console.log('All subscribers are gone...');
};
}
}
const store = new CustomStore();
const unsubscribe1 = store.subscribe(() => {}); // logs 'Got the fist subscriber!'
const unsubscribe2 = store.subscribe(() => {}); // nothing is logged as we've got one subscriber already
unsubscribe1(); // nothing is logged as we still have one subscriber
unsubscribe2(); // logs 'All subscribers are gone...' +
Protectedset- set(value): void
Replaces store's state with the provided value. Equivalent of Writable.set, but internal to the store.
-Parameters
value: T
value to be used as the new state of a store.
-
Returns void
subscribe
- subscribe(subscriber): UnsubscribeFunction & UnsubscribeObject
Default Implementation of the SubscribableStore.subscribe, not meant to be overridden.
-Parameters
subscriber: Subscriber<T>
Returns UnsubscribeFunction & UnsubscribeObject
Protectedupdatesubscribe
- subscribe(subscriber): UnsubscribeFunction & UnsubscribeObject
Default Implementation of the SubscribableStore.subscribe, not meant to be overridden.
+Parameters
- subscriber: Subscriber<T>
Returns UnsubscribeFunction & UnsubscribeObject
Protectedupdate- update(updater): void
Updates store's state by using an Updater function. Equivalent of Writable.update, but internal to the store.
-Parameters
Returns void
- on
\ No newline at end of file +Generated using TypeDoc
Parameters
Returns void
- not
asReadable | @amadeus-it-group/tansu Function asReadable
- as
Readable<T>(store): ReadableSignal<T> Returns a wrapper (for the given store) which only exposes the ReadableSignal interface. +
asReadable | @amadeus-it-group/tansu diff --git a/functions/asWritable.html b/functions/asWritable.html index f2bcd1e..8750c5c 100644 --- a/functions/asWritable.html +++ b/functions/asWritable.html @@ -1,20 +1,20 @@ -Function asReadable
- as
Readable<T>(store): ReadableSignal<T> Returns a wrapper (for the given store) which only exposes the ReadableSignal interface. This converts any StoreInput to a ReadableSignal and exposes the store as read-only.
-Type Parameters
Parameters
store: StoreInput<T>
store to wrap
+Type Parameters
Parameters
- store: StoreInput<T>
store to wrap
Returns ReadableSignal<T>
A wrapper which only exposes the ReadableSignal interface.
-- store: StoreInput<T>
- as
Readable<T, U>(store, extraProp): ReadableSignal<T> & Omit<U, keyof Readable<T>> Returns a wrapper (for the given store) which only exposes the ReadableSignal interface and +
- as
Readable<T, U>(store, extraProp): ReadableSignal<T> & Omit<U, keyof Readable<T>> Returns a wrapper (for the given store) which only exposes the ReadableSignal interface and also adds the given extra properties on the returned object.
-Type Parameters
Parameters
store: StoreInput<T>
store to wrap
-extraProp: U
extra properties to add on the returned object
+Type Parameters
Parameters
- store: StoreInput<T>
store to wrap
+ - extraProp: U
extra properties to add on the returned object
Returns ReadableSignal<T> & Omit<U, keyof Readable<T>>
A wrapper which only exposes the ReadableSignal interface and the given extra properties.
-- store: StoreInput<T>
\ No newline at end of file +Generated using TypeDoc
- as
asWritable | @amadeus-it-group/tansu Function asWritable
- as
Writable<T, W>(store, set?): WritableSignal<T, W> Returns a wrapper (for the given store) which only exposes the WritableSignal interface. +
asWritable | @amadeus-it-group/tansu Function asWritable
- as
Writable<T, W>(store, set?): WritableSignal<T, W> Returns a wrapper (for the given store) which only exposes the WritableSignal interface. When the value is changed from the given wrapper, the provided set function is called.
-Type Parameters
T
W = T
diff --git a/functions/batch.html b/functions/batch.html index b3e682c..c82601c 100644 --- a/functions/batch.html +++ b/functions/batch.html @@ -1,9 +1,7 @@ -Parameters
store: StoreInput<T>
store to wrap
-Optionalset: ((value) => void)function that will be called when the value is changed from the wrapper +
Type Parameters
- T
- W = T
Parameters
- store: StoreInput<T>
store to wrap
+ Optionalset: ((value: W) => void)function that will be called when the value is changed from the wrapper (through the set or the update function). If set is not specified, a noop function is used (so the value of the store cannot be changed from the returned wrapper).
-- (value): void
Replaces store's state with the provided value.
-Parameters
Returns WritableSignal<T, W>
A wrapper which only exposes the WritableSignal interface.
-- as
Writable<T, U, W>(store, extraProps): WritableSignal<T, W> & Omit<U, keyof WritableSignal<T, W>> Returns a wrapper (for the given store) which only exposes the WritableSignal interface and +
- as
Writable<T, U, W>(store, extraProps): WritableSignal<T, W> & Omit<U, keyof WritableSignal<T, W>> Returns a wrapper (for the given store) which only exposes the WritableSignal interface and also adds the given extra properties on the returned object.
-Type Parameters
T
U
W = T
Parameters
store: StoreInput<T>
store to wrap
-extraProps: U & Partial<Pick<WritableSignal<T, W>, "set" | "update">>
object containing the extra properties to add on the returned object, +
Type Parameters
- T
- U
- W = T
Parameters
- store: StoreInput<T>
store to wrap
+ - extraProps: U & Partial<Pick<WritableSignal<T, W>, "set" | "update">>
object containing the extra properties to add on the returned object, and optionally the set and the update function of the WritableSignal interface. If the set function is not specified, a noop function is used.
If the update function is not specified, a default function that calls set is used.
Returns WritableSignal<T, W> & Omit<U, keyof WritableSignal<T, W>>
A wrapper which only exposes the WritableSignal interface and the given extra properties.
-
\ No newline at end of file +Generated using TypeDoc
- as
batch | @amadeus-it-group/tansu diff --git a/functions/computed.html b/functions/computed.html index ff8dc57..555bc6f 100644 --- a/functions/computed.html +++ b/functions/computed.html @@ -1,8 +1,8 @@ -Function batch
- batch<T>(fn): T
Batches multiple changes to stores while calling the provided function, +
batch | @amadeus-it-group/tansu Function batch
Batches multiple changes to stores while calling the provided function, preventing derived stores from updating until the function returns, to avoid unnecessary recomputations.
-Type Parameters
Parameters
Returns T
Remarks
If a store is updated multiple times in the provided function, existing +
Remarks
If a store is updated multiple times in the provided function, existing subscribers of that store will only be called once when the provided function returns.
Note that even though the computation of derived stores is delayed in most @@ -16,7 +14,10 @@ intermediate computations, even inside batch.
It is possible to have nested calls of batch, in which case only the first (outer) call has an effect, inner calls only call the provided function.
-Example
Using batch in the following example prevents logging the intermediate "Sherlock Lupin" value.
-
-const firstName = writable('Arsène');
const lastName = writable('Lupin');
const fullName = derived([firstName, lastName], ([a, b]) => `${a} ${b}`);
fullName.subscribe((name) => console.log(name)); // logs any change to fullName
batch(() => {
firstName.set('Sherlock');
lastName.set('Holmes');
}); -\ No newline at end of file +Generated using TypeDoc
Example
Using batch in the following example prevents logging the intermediate "Sherlock Lupin" value.
+
+ +const firstName = writable('Arsène');
const lastName = writable('Lupin');
const fullName = derived([firstName, lastName], ([a, b]) => `${a} ${b}`);
fullName.subscribe((name) => console.log(name)); // logs any change to fullName
batch(() => {
firstName.set('Sherlock');
lastName.set('Holmes');
}); +
computed | @amadeus-it-group/tansu Function computed
- computed<T>(fn, options?): ReadableSignal<T>
Creates a store whose value is computed by the provided function.
-Type Parameters
diff --git a/functions/derived.html b/functions/derived.html index 935a1eb..7429d44 100644 --- a/functions/derived.html +++ b/functions/derived.html @@ -1,12 +1,14 @@ -Parameters
fn: (() => T)
computation function that returns the value of the store
-options: Omit<StoreOptions<T>, "onUse"> = {}
store option. Allows to define the equal function, if needed
+computed | @amadeus-it-group/tansu Function computed
- computed<T>(fn, options?): ReadableSignal<T>
Creates a store whose value is computed by the provided function.
+Type Parameters
Parameters
Returns ReadableSignal<T>
store containing the value returned by the computation function
-Remarks
The computation function is first called the first time the store is used.
+Remarks
The computation function is first called the first time the store is used.
It can use the value of other stores or observables and the computation function is called again if the value of those dependencies changed, as long as the store is still used.
Dependencies are detected automatically as the computation function gets their value either by calling the stores @@ -11,4 +11,4 @@ to wrap them in a call to untrack.
Note that dependencies can change between calls of the computation function. Internally, tansu will subscribe to new dependencies when they are used and unsubscribe from dependencies that are no longer used after the call of the computation function.
-\ No newline at end of file +Generated using TypeDoc
derived | @amadeus-it-group/tansu diff --git a/functions/equal.html b/functions/equal.html index eae31b1..bc2f4b2 100644 --- a/functions/equal.html +++ b/functions/equal.html @@ -1,8 +1,8 @@ -Function derived
- derived<T, S>(stores, options, initialValue): ReadableSignal<T>
A convenience function to create a new store with a state computed from the latest values of dependent stores. +
derived | @amadeus-it-group/tansu Function derived
- derived<T, S>(stores, options, initialValue): ReadableSignal<T>
A convenience function to create a new store with a state computed from the latest values of dependent stores. Each time the state of one of the dependent stores changes, a provided derive function is called to compute a new, derived state.
-Type Parameters
T
S extends StoresInput
Parameters
stores: S
a single store or an array of dependent stores
-options: AsyncDeriveFn<T, S> | AsyncDeriveOptions<T, S>
either an object with store options, including a derive function, or the derive function itself directly. +
Type Parameters
- T
- S extends StoresInput
Parameters
- stores: S
a single store or an array of dependent stores
+ - options: AsyncDeriveFn<T, S> | AsyncDeriveOptions<T, S>
either an object with store options, including a derive function, or the derive function itself directly. The derive function is used to compute a new state based on the latest values of dependent stores.
Alternatively, this function can accept a second argument,
-set, to manage asynchronous values. If you return a function from the callback, it will be called when the callback runs again, or the last subscriber unsubscribes. initialValue: T
Returns ReadableSignal<T>
Example: synchronous
-const x$ = writable(2);
const y$ = writable(3);
const sum$ = derived([x$, $y], ([x, y]) => x + y);
// will log 5 upon subscription
sum$.subscribe((value) => {
console.log(value)
});
x$.set(3); // will re-evaluate the `([x, y]) => x + y` function and log 6 as this is the new state of the derived store
-Example: asynchronous
-const x$ = writable(2);
const y$ = writable(3);
const sum$ = derived([x$, $y], ([x, y], set) => {
const timeoutId = setTimeout(() => set(x + y)));
return () => clearTimeout(timeoutId);
}, <number>undefined);
// will log undefined (the default value), then 5 asynchronously
sum$.subscribe((value) => {
console.log(value)
});
-- derived<T, S>(stores, options, initialValue?): ReadableSignal<T>
Type Parameters
T
S extends StoresInput
Parameters
stores: S
options: SyncDeriveFn<T, S> | SyncDeriveOptions<T, S>
OptionalinitialValue: T
Returns ReadableSignal<T>
\ No newline at end of file +Generated using TypeDoc
- initialValue: T
Returns ReadableSignal<T>
Example: synchronous
+ +const x$ = writable(2);
const y$ = writable(3);
const sum$ = derived([x$, y$], ([x, y]) => x + y);
// will log 5 upon subscription
sum$.subscribe((value) => {
console.log(value)
});
x$.set(3); // will re-evaluate the `([x, y]) => x + y` function and log 6 as this is the new state of the derived store
+Example: asynchronous
+ +const x$ = writable(2);
const y$ = writable(3);
const sum$ = derived([x$, $y], ([x, y], set) => {
const timeoutId = setTimeout(() => set(x + y)));
return () => clearTimeout(timeoutId);
}, <number>undefined);
// will log undefined (the default value), then 5 asynchronously
sum$.subscribe((value) => {
console.log(value)
});
+- derived<T, S>(stores, options, initialValue?): ReadableSignal<T>
Type Parameters
- T
- S extends StoresInput
Parameters
- stores: S
- options: SyncDeriveFn<T, S> | SyncDeriveOptions<T, S>
OptionalinitialValue: T
Returns ReadableSignal<T>
equal | @amadeus-it-group/tansu Function equal
- equal<T>(a, b): boolean
- diff --git a/functions/get.html b/functions/get.html index 4f378a2..b14fd56 100644 --- a/functions/get.html +++ b/functions/get.html @@ -1,6 +1,7 @@ -
Default implementation of the equal function used by tansu when a store +
equal | @amadeus-it-group/tansu Function equal
Default implementation of the equal function used by tansu when a store changes, to know if listeners need to be notified. Returns false if
-ais a function or an object, or ifaandbare different according toObject.is. Otherwise, returns true.Type Parameters
\ No newline at end of file +Generated using TypeDoc
get | @amadeus-it-group/tansu diff --git a/functions/readable.html b/functions/readable.html index 313b998..3f35ff3 100644 --- a/functions/readable.html +++ b/functions/readable.html @@ -1,9 +1,10 @@ -Function get
- get<T>(store): T
A utility function to get the current value from a given store. +
get | @amadeus-it-group/tansu Function get
A utility function to get the current value from a given store. It works by subscribing to a store, capturing the value (synchronously) and unsubscribing just after.
-Type Parameters
Parameters
store: StoreInput<T>
a store from which the current value is retrieved.
-
Returns T
Example
-const myStore = writable(1);
console.log(get(myStore)); // logs 1 -\ No newline at end of file +Generated using TypeDoc
- get<T>(store): T
Type Parameters
Parameters
- store: StoreInput<T>
a store from which the current value is retrieved.
+
Returns T
- store: StoreInput<T>
readable | @amadeus-it-group/tansu diff --git a/functions/untrack.html b/functions/untrack.html index ee27d1f..e779fdc 100644 --- a/functions/untrack.html +++ b/functions/untrack.html @@ -1,5 +1,5 @@ -Function readable
- readable<T>(value, options?): ReadableSignal<T>
A convenience function to create Readable store instances.
-Type Parameters
Parameters
value: T
Initial value of a readable store.
-options: StoreOptions<T> | OnUseFn<T> = {}
Either an object with store options, or directly the onUse function.
+readable | @amadeus-it-group/tansu Function readable
- readable<T>(value, options?): ReadableSignal<T>
A convenience function to create Readable store instances.
+Type Parameters
Parameters
- value: T
Initial value of a readable store.
+ Optionaloptions: StoreOptions<T> | OnUseFn<T>Either an object with store options, or directly the onUse function.
The onUse function is a function called when the number of subscribers changes from 0 to 1 (but not called when the number of subscribers changes from 1 to 2, ...).
If a function is returned, it will be called when the number of subscribers changes from 1 to 0.
-
Returns ReadableSignal<T>
Example: Sample with an onUse function
-const clock = readable("00:00", setState => {
const intervalID = setInterval(() => {
const date = new Date();
setState(`${date.getHours()}:${date.getMinutes()}:${date.getSeconds()}`);
}, 1000);
return () => clearInterval(intervalID);
}); -- value: T
\ No newline at end of file +Generated using TypeDoc
Returns ReadableSignal<T>
untrack | @amadeus-it-group/tansu Function untrack
- untrack<T>(fn): T
- diff --git a/functions/writable.html b/functions/writable.html index 7fa5383..e0b7f62 100644 --- a/functions/writable.html +++ b/functions/writable.html @@ -1,9 +1,10 @@ -
Stops the tracking of dependencies made by computed and calls the provided function. +
untrack | @amadeus-it-group/tansu writable | @amadeus-it-group/tansu diff --git a/hierarchy.html b/hierarchy.html index e03cae0..4a4fdf5 100644 --- a/hierarchy.html +++ b/hierarchy.html @@ -1 +1 @@ -Function writable
- writable<T>(value, options?): WritableSignal<T>
A convenience function to create Writable store instances.
-Type Parameters
Parameters
value: T
initial value of a new writable store.
-options: StoreOptions<T> | OnUseFn<T> = {}
Either an object with store options, or directly the onUse function.
+writable | @amadeus-it-group/tansu Function writable
- writable<T>(value, options?): WritableSignal<T>
A convenience function to create Writable store instances.
+Type Parameters
Parameters
- value: T
initial value of a new writable store.
+ Optionaloptions: StoreOptions<T> | OnUseFn<T>Either an object with store options, or directly the onUse function.
The onUse function is a function called when the number of subscribers changes from 0 to 1 (but not called when the number of subscribers changes from 1 to 2, ...).
If a function is returned, it will be called when the number of subscribers changes from 1 to 0.
-
Returns WritableSignal<T>
Example
-const x = writable(0);
x.update(v => v + 1); // increment
x.set(0); // reset back to the default value -- value: T
\ No newline at end of file +Generated using TypeDoc
Returns WritableSignal<T>
@amadeus-it-group/tansu \ No newline at end of file +Generated using TypeDoc
@amadeus-it-group/tansu diff --git a/index.html b/index.html index db78e2b..d64a929 100644 --- a/index.html +++ b/index.html @@ -1,8 +1,8 @@ -@amadeus-it-group/tansu diff --git a/interfaces/AsyncDeriveOptions.html b/interfaces/AsyncDeriveOptions.html index e2ee071..857abaf 100644 --- a/interfaces/AsyncDeriveOptions.html +++ b/interfaces/AsyncDeriveOptions.html @@ -1,54 +1,29 @@ -@amadeus-it-group/tansu
Tansu
+
@amadeus-it-group/tansu @amadeus-it-group/tansu
Tansu
+
-
Tansu is a lightweight, push-based framework-agnostic state management library. -It borrows the ideas and APIs originally designed and implemented by Svelte stores +It borrows the ideas and APIs originally designed and implemented by Svelte stores and extends them with
computedandbatch.Main characteristics:
-
@@ -12,76 +12,89 @@
- results in compact code with the absolute minimum of boilerplate.
Implementation wise, it is a tiny (1300 LOC) library without any external dependencies.
-Installation
You can add Tansu to your project by installing the
+@amadeus-it-group/tansupackage using your favorite package manager, ex.:Installation
You can add Tansu to your project by installing the
@amadeus-it-group/tansupackage using your favorite package manager, ex.:yarn add @amadeus-it-group/tansunpm install @amadeus-it-group/tansu
Usage
Check out the Tansu API documentation.
+Usage
Check out the Tansu API documentation.
The functional part of the API to manage your reactive state can be categorized into three distinct groups:
- Base store:
writable - Computed stores:
derived,computed,readable - Utilities:
batch,asReadable,asWritable
writable
+writable
Writable: A Fundamental Building Block
A
writableserves as the foundational element of a "store" – a container designed to encapsulate a value, enabling observation and modification of its state. You can change the internal value using thesetorupdatemethods.To receive notifications whenever the value undergoes a change, the
-subscribe()method, paired with a callback function, can be employed.Basic usage
+import {writable} from "@amadeus-it-group/tansu";
const value$ = writable(0);
const unsubscribe = values$.subscribe((value) => {
console.log(`value = ${value}`);
});
value$.set(1);
value$.update((value) => value + 1); -Basic usage
+import {writable} from "@amadeus-it-group/tansu";
const value$ = writable(0);
const unsubscribe = values$.subscribe((value) => {
console.log(`value = ${value}`);
});
value$.set(1);
value$.update((value) => value + 1); +output:
-
+ +value = 0 +
-value = 0 value = 1 value = 2 -Setup and teardown
The writable's second parameter allows for receiving notifications when at least one subscriber subscribes or when there are no more subscribers.
-
+import {writable} from "@amadeus-it-group/tansu";
const value$ = writable(0, () => {
console.log('At least one subscriber');
return () => {
console.log('No more subscriber');
}
});
const unsubscribe = values$.subscribe((value) => {
console.log(`value = ${value}`);
});
value$.set(1);
unsubscribe(); -Setup and teardown
The writable's second parameter allows for receiving notifications when at least one subscriber subscribes or when there are no more subscribers.
+
+import {writable} from "@amadeus-it-group/tansu";
const value$ = writable(0, () => {
console.log('At least one subscriber');
return () => {
console.log('No more subscriber');
}
});
const unsubscribe = values$.subscribe((value) => {
console.log(`value = ${value}`);
});
value$.set(1);
unsubscribe(); +output:
-
+ +At least one subscriber +
-At least one subscriber value = 0 value = 1 No more subscriber -derived
+derived
A
-derivedstore calculates its value based on one or more other stores provided as parameters. Since its value is derived from other stores, it is a read-only store and does not have anysetorupdatemethods.Single store
+import {writable, derived} from "@amadeus-it-group/tansu";
const value$ = writable(1);
const double$ = derived(value$, (value) => value * 2);
double$.subscribe((double) => console.log('Double value', double));
value$.set(2); -Single store
+import {writable, derived} from "@amadeus-it-group/tansu";
const value$ = writable(1);
const double$ = derived(value$, (value) => value * 2);
double$.subscribe((double) => console.log('Double value', double));
value$.set(2); +output:
-
+ +Double value 2 +
-Double value 2 Double value 4 -Multiple stores
+import {writable, derived} from "@amadeus-it-group/tansu";
const a$ = writable(1);
const b$ = writable(1);
const sum$ = derived([a$, b$], ([a, b]) => a + b);
sum$.subscribe((sum) => console.log('Sum', sum));
a$.set(2); -Multiple stores
+import {writable, derived} from "@amadeus-it-group/tansu";
const a$ = writable(1);
const b$ = writable(1);
const sum$ = derived([a$, b$], ([a, b]) => a + b);
sum$.subscribe((sum) => console.log('Sum', sum));
a$.set(2); +output:
-
+ +Sum 2 +
-Sum 2 Sum 3 -Asynchronous set
A
-derivedcan directly manipulate its value using the set method instead of relying on the returned value of the provided function. -This flexibility allows you to manage asynchronous operations or apply filtering logic before updating the observable's value.
+import {writable, derived} from "@amadeus-it-group/tansu";
const a$ = writable(0);
const asynchronousDouble$ = derived(a$, (a, set) => {
const plannedLater = setTimeout(() => set(a * 2));
return () => {
// This clean-up function is called if there is no listener anymore,
// or if the value of a$ changed
// In this case, the function passed to setTimeout should not be called
// (if it was not called already)
clearTimeout(plannedLater);
};
}, -1);
const evenOnly$ = derived(a$, (a, set) => {
if (a % 2 === 0) {
set(a);
}
}, <number | undefined>undefined);
asynchronousDouble$.subscribe((double) => console.log('Double (asynchronous)', double));
evenOnly$.subscribe((value) => console.log('Even', value));
a$.set(1);
a$.set(2); -Asynchronous set
A
+derivedcan directly manipulate its value using the set method instead of relying on the returned value of the provided function. +This flexibility allows you to manage asynchronous operations or apply filtering logic before updating the observable's value.
+import {writable, derived} from "@amadeus-it-group/tansu";
const a$ = writable(0);
const asynchronousDouble$ = derived(a$, (a, set) => {
const plannedLater = setTimeout(() => set(a * 2));
return () => {
// This clean-up function is called if there is no listener anymore,
// or if the value of a$ changed
// In this case, the function passed to setTimeout should not be called
// (if it was not called already)
clearTimeout(plannedLater);
};
}, -1);
const evenOnly$ = derived(a$, (a, set) => {
if (a % 2 === 0) {
set(a);
}
}, <number | undefined>undefined);
asynchronousDouble$.subscribe((double) => console.log('Double (asynchronous)', double));
evenOnly$.subscribe((value) => console.log('Even', value));
a$.set(1);
a$.set(2); +output:
-
+ +Double (asynchronous) -1 +
-Double (asynchronous) -1 Even 0 Even 2 Double (asynchronous) 4 -computed
+computed
A
computedstore is another variant of a derived store, with the following characteristics:-
-
Implicit Dependencies: Unlike in a derived store, there is no requirement to explicitly declare dependencies.
+-
+
Implicit Dependencies: Unlike in a derived store, there is no requirement to explicitly declare dependencies.
- Dynamic Dependency Listening: Dependencies are determined based on their usage. This implies that a dependency not actively used is not automatically "listened" to, optimizing resource utilization.
+-
+
Dynamic Dependency Listening: Dependencies are determined based on their usage. This implies that a dependency not actively used is not automatically "listened" to, optimizing resource utilization.
Switch map
This capability to subscribe/unsubscribe to the dependency allows to create switch maps in a natural way.
-
+import {writable, computed} from "@amadeus-it-group/tansu";
const switchToA$ = writable(true);
const a$ = writable(1);
const b$ = writable(0);
const computedValue$ = computed(() => {
if (switchToA$()) {
console.log('Return a$');
return a$();
} else {
console.log('Return b$');
return b$();
}
});
computedValue$.subscribe((value) => console.log('Computed value:', value));
a$.set(2);
switchToA$.set(false);
a$.set(3);
a$.set(4);
switchToA$.set(true);
-Switch map
This capability to subscribe/unsubscribe to the dependency allows to create switch maps in a natural way.
+
+import {writable, computed} from "@amadeus-it-group/tansu";
const switchToA$ = writable(true);
const a$ = writable(1);
const b$ = writable(0);
const computedValue$ = computed(() => {
if (switchToA$()) {
console.log('Return a$');
return a$();
} else {
console.log('Return b$');
return b$();
}
});
computedValue$.subscribe((value) => console.log('Computed value:', value));
a$.set(2);
switchToA$.set(false);
a$.set(3);
a$.set(4);
switchToA$.set(true);
+output:
-
+Return a$ +
+Return a$ Computed value: 1 Return a$ Computed value: 2 @@ -89,51 +102,59 @@ Computed value: 0 Return a$ Computed value: 4 -When
-switchToA$.set(false)is called, the subscription toa$is canceled, which means that subsequent changes toa$will no longer trigger the calculation., which is only performed again when switchToA$ is set back to true.readable
+readable
Similar to Svelte stores, this function generates a store where the value cannot be externally modified.
-
-import {readable} from '@amadeus-it-group/tansu';
const time = readable(new Date(), (set) => {
const interval = setInterval(() => {
set(new Date());
}, 1000);
return () => clearInterval(interval);
}); -derived vs computed
While derived and computed may appear similar, they exhibit distinct characteristics that can significantly impact effectiveness based on use-cases:
+
+ +import {readable} from '@amadeus-it-group/tansu';
const time = readable(new Date(), (set) => {
const interval = setInterval(() => {
set(new Date());
}, 1000);
return () => clearInterval(interval);
}); +derived vs computed
While derived and computed may appear similar, they exhibit distinct characteristics that can significantly impact effectiveness based on use-cases:
-
-
Declaration of Dependencies:
+-
+
Declaration of Dependencies:
computed: No explicit declaration of dependencies is required, providing more flexibility in code composition.derived: Requires explicit declaration of dependencies.
- Performance:
+-
+
Performance:
computed: Better performance by re-running the function only based on changes in the stores involved in the last run.derived: Re-run the function each time a dependent store changes.
- Asynchronous State:
+-
+
Asynchronous State:
computed: Unable to manage asynchronous state.derived: Can handle asynchronous state with thesetmethod.
- Skipping Value Emission:
+-
+
Skipping Value Emission:
computed: Does not provide a mechanism to skip emitting values.derived: Allows skipping the emission of values by choosing not to call the providedsetmethod.
- Setup and Teardown:
+-
+
Setup and Teardown:
computed: Lacks explicit setup and teardown methods.derived: Supports setup and teardown methods, allowing actions such as adding or removing DOM listeners.
-- When the last listener unsubscribes and then subscribes again, the derived function is rerun due to its setup-teardown functionality. In contrast, a computed provides the last value without recomputing if dependencies haven't changed in the meantime. +
- When the last listener unsubscribes and then subscribes again, the derived function is rerun due to its setup-teardown functionality. In contrast, a computed provides the last value without recomputing if dependencies haven't changed in the meantime.
While
computedfeels more intuitive in many use-cases,derivedexcels in scenarios wherecomputedfalls short, particularly in managing asynchronous state and providing more granular control over value emissions.Carefully choosing between them based on specific requirements enhances the effectiveness of state management in your application.
-Getting the value
There are three ways for getting the value of a store:
-
+import {writable, get} from "@amadeus-it-group/tansu";
const count$ = writable(1);
const unsubscribe = count$.subscribe((count) => {
// Will be called with the updated value synchronously first, then each time count$ changes.
// `unsubscribe` must be called to prevent future calls.
console.log(count);
});
// A store is also a function that you can call to get the instant value.
console.log(count$());
// Equivalent to
console.log(get(count$)); -Getting the value
There are three ways for getting the value of a store:
+
+import {writable, get} from "@amadeus-it-group/tansu";
const count$ = writable(1);
const unsubscribe = count$.subscribe((count) => {
// Will be called with the updated value synchronously first, then each time count$ changes.
// `unsubscribe` must be called to prevent future calls.
console.log(count);
});
// A store is also a function that you can call to get the instant value.
console.log(count$());
// Equivalent to
console.log(get(count$)); +
-[!NOTE] Getting the instant value implies the subscription and unsubription on the store:
@@ -143,68 +164,77 @@When called inside a reactive context (i.e. inside a computed), getting the value serves to know and "listen" the dependent stores.
batch
+batch
Contrary to other libraries like Angular with signals or Svelte with runes, where the callback of a subscription is executed asynchronously (usually referenced as an "effect"), we have maintained the constraint of synchronicity between the store changes and their subscriptions in Tansu.
While it is acceptable for these frameworks to defer these calls since their goals are well-known in advance (to optimize their final rendering), this is not the case for Tansu, where the goal is to be adaptable to any situation.
The problem with synchronous subscriptions is that it can create "glitches". Subscribers and computed store callbacks that are run too many times can create incorrect intermediate values.
-Svelte stores resolved the diamond dependency issue, but it does not match all the use-cases.
-Let's have a look at the following example:
-
+import {writable, derived} from '@amadeus-it-group/tansu';
const firstName = writable('Arsène');
const lastName = writable('Lupin');
const fullName = derived([firstName, lastName], ([a, b]) => `${a} ${b}`);
fullName.subscribe((name) => console.log(name)); // logs any change to fullName
firstName.set('Sherlock');
lastName.set('Holmes');
console.log('Process end'); -Svelte stores resolved the diamond dependency issue, but it does not match all the use-cases.
+Let's have a look at the following example:
+
+import {writable, derived} from '@amadeus-it-group/tansu';
const firstName = writable('Arsène');
const lastName = writable('Lupin');
const fullName = derived([firstName, lastName], ([a, b]) => `${a} ${b}`);
fullName.subscribe((name) => console.log(name)); // logs any change to fullName
firstName.set('Sherlock');
lastName.set('Holmes');
console.log('Process end'); +output:
-
+Arsène Lupin +
+Arsène Lupin Sherlock Lupin Sherlock Holmes Process end -The fullName store successively went through different states, including an inconsistent one, as
Sherlock Lupindoes not exist! Even if it can be seen as just an intermediate state, it is fundamental for a state management to only manage consistent data in order to prevent issues and optimize the code.In Tansu, the
batchis available to defer synchronously the subscribers calls, and de facto the dependentderivedorcomputedcalculation to solve all kind of multiple dependencies issues.The previous example is resolved this way:
-
+import {writable, derived, computed, batch} from '@amadeus-it-group/tansu';
const firstName = writable('Arsène');
const lastName = writable('Lupin');
const fullName = derived([firstName, lastName], ([a, b]) => `${a} ${b}`);
// note that the fullName store could alternatively be create with computed:
// const fullName = computed(() => `${firstName()} ${lastName()}`);
fullName.subscribe((name) => console.log(name)); // logs any change to fullName
batch(() => {
firstName.set('Sherlock');
lastName.set('Holmes');
});
console.log('Process end'); -
+import {writable, derived, computed, batch} from '@amadeus-it-group/tansu';
const firstName = writable('Arsène');
const lastName = writable('Lupin');
const fullName = derived([firstName, lastName], ([a, b]) => `${a} ${b}`);
// note that the fullName store could alternatively be create with computed:
// const fullName = computed(() => `${firstName()} ${lastName()}`);
fullName.subscribe((name) => console.log(name)); // logs any change to fullName
batch(() => {
firstName.set('Sherlock');
lastName.set('Holmes');
});
console.log('Process end'); +output:
-
+Arsène Lupin +
+Arsène Lupin Sherlock Holmes Process end -
-[!NOTE]
- Retrieving the immediate value of a store (using any of the three methods mentioned earlier: calling
subscribewith a subscriber that will be called with the value synchronously, usinggetor calling the store as a function) always provides the value based on the up-to-date values of all dependent stores (even if this requires re-computations of a computed or a derived inside the batch) - all calls to subscribers (excluding the first synchronous call during the subscribe process) are deferred until the end of the batch -
- if a subscriber has already been notified of a new value inside the batch (for example, when it is a new subscriber registered within the batch), it won't be notified again at the end of the batch if the value remains unchanged. Subscribers are invoked only when the store's value has changed since their last call. +
- if a subscriber has already been notified of a new value inside the batch (for example, when it is a new subscriber registered within the batch), it won't be notified again at the end of the batch if the value remains unchanged. Subscribers are invoked only when the store's value has changed since their last call.
batchcan be called insidebatch. The subscriber calls are performed at the end of the first batch, synchronously.
asReadable
+asReadable
asReadablereturns a new store that exposes only the essential elements needed for subscribing to the store. It also includes any extra methods passed as parameters.This is useful and widely used to compose a custom store:
- The first parameter is the writable store,
- The second parameter is an object to extend the readable store returned.
+import {writable, asReadable} from "@amadeus-it-group/tansu";
function createCounter(initialValue: number) {
const store$ = writable(initialValue);
return asReadable(store$, {
increment: () => store$.update((value) => value + 1),
decrement: () => store$.update((value) => value - 1),
reset: () => store$.set(initialValue)
});
}
const counter$ = createCounter(0);
counter$.subscribe((value) => console.log('Value: ', value));
counter$.increment();
counter$.reset();
counter$.set(2); // Error, set does not exist -
+import {writable, asReadable} from "@amadeus-it-group/tansu";
function createCounter(initialValue: number) {
const store$ = writable(initialValue);
return asReadable(store$, {
increment: () => store$.update((value) => value + 1),
decrement: () => store$.update((value) => value - 1),
reset: () => store$.set(initialValue)
});
}
const counter$ = createCounter(0);
counter$.subscribe((value) => console.log('Value: ', value));
counter$.increment();
counter$.reset();
counter$.set(2); // Error, set does not exist +output:
-
+ +Value: 0 +
-Value: 0 Value: 1 Value: 0 (Error thrown !) -asWritable
-
-asWritableis almost the same as anasReadable, with the key difference being its implementation of the WritableSignal interface.It's useful when you want to connect your computed store to the original one, or implement a custom
+setmethod. Thesetmethod can be passed directly in the second parameter or within an object, similar to the usage inasReadable.asWritable
+
+asWritableis almost the same as anasReadable, with the key difference being its implementation of the WritableSignal interface.It's useful when you want to connect your computed store to the original one, or implement a custom
setmethod. Thesetmethod can be passed directly in the second parameter or within an object, similar to the usage inasReadable.For example:
-
+import {writable, asWritable} from "@amadeus-it-group/tansu";
const number$ = writable(1);
const double$ = computed(() => number$() * 2);
const writableDouble$ = asWritable(double$, (doubleNumber) => {
number$.set(doubleNumber / 2);
});
/* equivalent to:
const writableDouble$ = asWritable(double$, {
set: (doubleNumber) => number$.set(doubleNumber / 2)
});
*/
writableDouble$.subscribe((value) => console.log('Value: ', value));
writableDouble$.set(2); // Nothing is triggered here, as number$ is already set with 1
writableDouble$.set(4);
-
+import {writable, asWritable} from "@amadeus-it-group/tansu";
const number$ = writable(1);
const double$ = computed(() => number$() * 2);
const writableDouble$ = asWritable(double$, (doubleNumber) => {
number$.set(doubleNumber / 2);
});
/* equivalent to:
const writableDouble$ = asWritable(double$, {
set: (doubleNumber) => number$.set(doubleNumber / 2)
});
*/
writableDouble$.subscribe((value) => console.log('Value: ', value));
writableDouble$.set(2); // Nothing is triggered here, as number$ is already set with 1
writableDouble$.set(4);
+output:
-
+ +Value: 2 +
-Value: 2 Value: 4 -Integration in frameworks
Tansu works well with the Svelte framework
Tansu is designed to be and to remain fully compatible with Svelte.
-Tansu works well with the Angular ecosystem
Here is an example of an Angular component using a Tansu store:
-
+import { Component } from "@angular/core";
import { AsyncPipe } from '@angular/common';
import { Store, computed, get } from "@amadeus-it-group/tansu";
// A store is a class extending Store from Tansu
class CounterStore extends Store<number> {
constructor() {
super(0); // initialize store's value (state)
}
// implement state manipulation logic as regular methods
increment() {
// create new state based on the current state
this.update(value => value + 1);
}
reset() {
// replace the entire state with a new value
this.set(0);
}
}
@Component({
selector: "my-app",
template: `
<button (click)="counter$.increment()">+</button> <br />
<!-- store values can be displayed in a template with the standard async pipe -->
Counter: {{ counter$ | async }} <br />
Double counter: {{ doubleCounter$ | async }} <br />
`,
standalone: true,
imports: [AsyncPipe]
})
export class App {
// A store can be instantiated directly or registered in the DI container
counter$ = new CounterStore();
// One can easily create computed values by specifying a transformation function
doubleCounter$ = computed(() => 2 * get(this.counter$));
} -Integration in frameworks
Tansu works well with the Svelte framework
Tansu is designed to be and to remain fully compatible with Svelte.
+Tansu works well with the Angular ecosystem
Here is an example of an Angular component using a Tansu store:
+
+import { Component } from "@angular/core";
import { AsyncPipe } from '@angular/common';
import { Store, computed, get } from "@amadeus-it-group/tansu";
// A store is a class extending Store from Tansu
class CounterStore extends Store<number> {
constructor() {
super(0); // initialize store's value (state)
}
// implement state manipulation logic as regular methods
increment() {
// create new state based on the current state
this.update(value => value + 1);
}
reset() {
// replace the entire state with a new value
this.set(0);
}
}
@Component({
selector: "my-app",
template: `
<button (click)="counter$.increment()">+</button> <br />
<!-- store values can be displayed in a template with the standard async pipe -->
Counter: {{ counter$ | async }} <br />
Double counter: {{ doubleCounter$ | async }} <br />
`,
standalone: true,
imports: [AsyncPipe]
})
export class App {
// A store can be instantiated directly or registered in the DI container
counter$ = new CounterStore();
// One can easily create computed values by specifying a transformation function
doubleCounter$ = computed(() => 2 * get(this.counter$));
} +While being fairly minimal, this example demonstrates most of the Tansu APIs with Angular.
- works with the standard
asyncpipe out of the box
@@ -212,9 +242,9 @@
- stores can be used easily with rxjs because they implement the
InteropObservableinterface - conversely, rxjs observables (or any object implementing the
InteropObservableinterface) can easily be used with Tansu (e.g. in Tansucomputedorderived).
Contributing to the project
Please check the DEVELOPER.md for documentation on building and testing the project on your local development machine.
-Credits and the prior art
-
-
- Svelte gets all the credit for the initial idea and the API design. -
- NgRx component stores solve a similar problem with a different approach. +
- Svelte gets all the credit for the initial idea and the API design. +
- NgRx component stores solve a similar problem with a different approach.
Contributing to the project
Please check the DEVELOPER.md for documentation on building and testing the project on your local development machine.
+Credits and the prior art
-
+
\ No newline at end of file +Generated using TypeDoc
AsyncDeriveOptions | @amadeus-it-group/tansu Interface AsyncDeriveOptions<T, S>
interface AsyncDeriveOptions<T, S> {
    derive: AsyncDeriveFn<T, S>;
    equal?: ((a, b) => boolean);
    notEqual?: ((a, b) => boolean);
}Type Parameters
Hierarchy
- Omit<StoreOptions<T>, "onUse">
- AsyncDeriveOptions
Properties
derive
Optionalequalequal?: ((a, b) => boolean)Custom function to compare two values, that should return true if they +
AsyncDeriveOptions | @amadeus-it-group/tansu diff --git a/interfaces/InteropObservable.html b/interfaces/InteropObservable.html index 4676c4c..5cfe365 100644 --- a/interfaces/InteropObservable.html +++ b/interfaces/InteropObservable.html @@ -1,3 +1,3 @@ -Interface AsyncDeriveOptions<T, S>
interface AsyncDeriveOptions<T, S> {
    derive: AsyncDeriveFn<T, S>;
    equal?: ((a: T, b: T) => boolean);
    notEqual?: ((a: T, b: T) => boolean);
}Type Parameters
Hierarchy
- Omit<StoreOptions<T>, "onUse">
- AsyncDeriveOptions
Properties
derive
OptionalequalCustom function to compare two values, that should return true if they are equal.
It is called when setting a new value to avoid doing anything (such as notifying subscribers) if the value did not change.
-Type declaration
- (a, b): boolean
Custom function to compare two values, that should return true if they -are equal.
-It is called when setting a new value to avoid doing anything -(such as notifying subscribers) if the value did not change.
-Parameters
a: T
First value to compare.
-b: T
Second value to compare.
+Type declaration
- (a, b): boolean
Returns boolean
true if a and b are considered equal.
-
Remarks
The default logic (when this option is not present) is to return false +
Remarks
The default logic (when this option is not present) is to return false if
ais a function or an object, or ifaandbare different according toObject.is.equal takes precedence over notEqual if both are defined.
-Param: a
First value to compare.
-Param: b
Second value to compare.
-Returns
true if a and b are considered equal.
-OptionalnotEqual notEqual?: ((a, b) => boolean) Custom function to compare two values, that should return true if they +
OptionalnotEqual Custom function to compare two values, that should return true if they are different.
It is called when setting a new value to avoid doing anything (such as notifying subscribers) if the value did not change.
-Type declaration
- (a, b): boolean
Custom function to compare two values, that should return true if they -are different.
-It is called when setting a new value to avoid doing anything -(such as notifying subscribers) if the value did not change.
-Parameters
a: T
First value to compare.
-b: T
Second value to compare.
+Type declaration
- (a, b): boolean
Returns boolean
true if a and b are considered different.
-Remarks
The default logic (when this option is not present) is to return true -if
-ais a function or an object, or ifaandbare different -according toObject.is.StoreOptions.equal takes precedence over notEqual if both -are defined.
-Deprecated
Use StoreOptions.equal instead
-
Remarks
The default logic (when this option is not present) is to return true +
Remarks
The default logic (when this option is not present) is to return true if
ais a function or an object, or ifaandbare different according toObject.is.StoreOptions.equal takes precedence over notEqual if both are defined.
-Deprecated
Use StoreOptions.equal instead
-Param: a
First value to compare.
-Param: b
Second value to compare.
-Returns
true if a and b are considered different.
-
\ No newline at end of file +Generated using TypeDoc
Deprecated
Use StoreOptions.equal instead
+
InteropObservable | @amadeus-it-group/tansu Interface InteropObservable<T>
An interface for interoperability between observable implementations. It only has to expose the
-[Symbol.observable]method that is supposed to return a subscribable store.Type Parameters
Hierarchy (view full)
- InteropObservable
Index
Properties
Properties
[observable]
Type declaration
- (): SubscribableStore<T>
Returns SubscribableStore<T>
\ No newline at end of file +Generated using TypeDoc
InteropObservable | @amadeus-it-group/tansu diff --git a/interfaces/OnUseArgument.html b/interfaces/OnUseArgument.html index f7387b8..b4ebd43 100644 --- a/interfaces/OnUseArgument.html +++ b/interfaces/OnUseArgument.html @@ -1,3 +1,3 @@ -Interface InteropObservable<T>
An interface for interoperability between observable implementations. It only has to expose the
+[Symbol.observable]method that is supposed to return a subscribable store.Type Parameters
Hierarchy (view full)
- InteropObservable
Index
Properties
OnUseArgument | @amadeus-it-group/tansu Interface OnUseArgument<T>
interface OnUseArgument<T> {
    set: ((value) => void);
    update: ((updater) => void);
    (value): void;
}Type Parameters
- On
Use Argument(value): void Parameters
value: T
Returns void
Properties
set
set: ((value) => void)Type declaration
- (value): void
Parameters
value: T
Returns void
update
update: ((updater) => void)\ No newline at end of file +Generated using TypeDoc
OnUseArgument | @amadeus-it-group/tansu diff --git a/interfaces/Readable-1.html b/interfaces/Readable-1.html index 0886922..1debd99 100644 --- a/interfaces/Readable-1.html +++ b/interfaces/Readable-1.html @@ -1,10 +1,12 @@ -Readable | @amadeus-it-group/tansu Interface Readable<T>
diff --git a/interfaces/ReadableSignal.html b/interfaces/ReadableSignal.html index 39d7194..d7035fa 100644 --- a/interfaces/ReadableSignal.html +++ b/interfaces/ReadableSignal.html @@ -1,10 +1,12 @@ -This interface augments the base SubscribableStore interface by requiring the return value of the subscribe method to be both a function and an object with the
+unsubscribemethod.Readable | @amadeus-it-group/tansu Interface Readable<T>
This interface augments the base SubscribableStore interface by requiring the return value of the subscribe method to be both a function and an object with the
unsubscribemethod.For interoperability with rxjs, it also implements the
-[Symbol.observable]method.interface Readable<T> {
    [observable](): Readable<T>;
    subscribe(subscriber): UnsubscribeFunction & UnsubscribeObject;
}Type Parameters
Hierarchy (view full)
Implemented by
Index
Methods
Methods
[observable]
subscribe
- subscribe(subscriber): UnsubscribeFunction & UnsubscribeObject
A method that makes it possible to register "interest" in store value changes over time. -It is called each and every time the store's value changes.
+
interface Readable<T> {
    [observable](): Readable<T>;
    get(): T;
    subscribe(subscriber: Subscriber<T>): UnsubscribeFunction & UnsubscribeObject;
}Type Parameters
Hierarchy (view full)
Implemented by
Index
Methods
Methods
[observable]
get
subscribe
- subscribe(subscriber): UnsubscribeFunction & UnsubscribeObject
A method that makes it possible to register "interest" in store value changes over time. +It is called each and every time the store's value changes.
A registered subscriber is notified synchronously with the latest store value.
-Parameters
subscriber: Subscriber<T>
a subscriber in a form of a SubscriberFunction or a SubscriberObject. Returns a Unsubscriber (function or object with the
+unsubscribemethod) that can be used to unregister and stop receiving notifications of store value changes.Parameters
- subscriber: Subscriber<T>
a subscriber in a form of a SubscriberFunction or a SubscriberObject. Returns a Unsubscriber (function or object with the
unsubscribemethod) that can be used to unregister and stop receiving notifications of store value changes.
Returns UnsubscribeFunction & UnsubscribeObject
The UnsubscribeFunction or UnsubscribeObject that can be used to unsubscribe (stop state change notifications).
-- subscriber: Subscriber<T>
\ No newline at end of file +Generated using TypeDoc
ReadableSignal | @amadeus-it-group/tansu Interface ReadableSignal<T>
This interface augments the base Readable interface by adding the ability to call the store as a function to get its value.
-interface ReadableSignal<T> {
    [observable](): Readable<T>;
    subscribe(subscriber): UnsubscribeFunction & UnsubscribeObject;
    (): T;
}Type Parameters
Hierarchy (view full)
Index
Methods
Methods
[observable]
subscribe
- subscribe(subscriber): UnsubscribeFunction & UnsubscribeObject
- diff --git a/interfaces/SignalStore.html b/interfaces/SignalStore.html new file mode 100644 index 0000000..f3f97c2 --- /dev/null +++ b/interfaces/SignalStore.html @@ -0,0 +1,4 @@ +
A method that makes it possible to register "interest" in store value changes over time. -It is called each and every time the store's value changes.
+ReadableSignal | @amadeus-it-group/tansu Interface ReadableSignal<T>
This interface augments the base Readable interface by adding the ability to call the store as a function to get its value.
+interface ReadableSignal<T> {
    [observable](): Readable<T>;
    get(): T;
    subscribe(subscriber: Subscriber<T>): UnsubscribeFunction & UnsubscribeObject;
    (): T;
}Type Parameters
Hierarchy (view full)
Index
Methods
Methods
[observable]
get
subscribe
- subscribe(subscriber): UnsubscribeFunction & UnsubscribeObject
A method that makes it possible to register "interest" in store value changes over time. +It is called each and every time the store's value changes.
A registered subscriber is notified synchronously with the latest store value.
-Parameters
subscriber: Subscriber<T>
a subscriber in a form of a SubscriberFunction or a SubscriberObject. Returns a Unsubscriber (function or object with the
+unsubscribemethod) that can be used to unregister and stop receiving notifications of store value changes.Parameters
- subscriber: Subscriber<T>
a subscriber in a form of a SubscriberFunction or a SubscriberObject. Returns a Unsubscriber (function or object with the
unsubscribemethod) that can be used to unregister and stop receiving notifications of store value changes.
Returns UnsubscribeFunction & UnsubscribeObject
The UnsubscribeFunction or UnsubscribeObject that can be used to unsubscribe (stop state change notifications).
-- subscriber: Subscriber<T>
\ No newline at end of file +Generated using TypeDoc
SignalStore | @amadeus-it-group/tansu diff --git a/interfaces/StoreOptions.html b/interfaces/StoreOptions.html index f3c563a..6cff134 100644 --- a/interfaces/StoreOptions.html +++ b/interfaces/StoreOptions.html @@ -1,58 +1,33 @@ -StoreOptions | @amadeus-it-group/tansu Interface StoreOptions<T>
interface StoreOptions<T> {
    equal?: ((a, b) => boolean);
    notEqual?: ((a, b) => boolean);
    onUse?: OnUseFn<T>;
}Type Parameters
Properties
Optionalequalequal?: ((a, b) => boolean)Custom function to compare two values, that should return true if they +
StoreOptions | @amadeus-it-group/tansu diff --git a/interfaces/SubscribableStore.html b/interfaces/SubscribableStore.html index 67bda92..db2e38f 100644 --- a/interfaces/SubscribableStore.html +++ b/interfaces/SubscribableStore.html @@ -1,8 +1,8 @@ -Interface StoreOptions<T>
interface StoreOptions<T> {
    equal?: ((a: T, b: T) => boolean);
    notEqual?: ((a: T, b: T) => boolean);
    onUse?: OnUseFn<T>;
}Type Parameters
Properties
OptionalequalCustom function to compare two values, that should return true if they are equal.
It is called when setting a new value to avoid doing anything (such as notifying subscribers) if the value did not change.
-Type declaration
- (a, b): boolean
Custom function to compare two values, that should return true if they -are equal.
-It is called when setting a new value to avoid doing anything -(such as notifying subscribers) if the value did not change.
-Parameters
a: T
First value to compare.
-b: T
Second value to compare.
+Type declaration
- (a, b): boolean
Returns boolean
true if a and b are considered equal.
-
Remarks
The default logic (when this option is not present) is to return false +
Remarks
The default logic (when this option is not present) is to return false if
ais a function or an object, or ifaandbare different according toObject.is.equal takes precedence over notEqual if both are defined.
-Param: a
First value to compare.
-Param: b
Second value to compare.
-Returns
true if a and b are considered equal.
-OptionalnotEqual notEqual?: ((a, b) => boolean) Custom function to compare two values, that should return true if they +
OptionalnotEqual Custom function to compare two values, that should return true if they are different.
It is called when setting a new value to avoid doing anything (such as notifying subscribers) if the value did not change.
-Type declaration
- (a, b): boolean
Custom function to compare two values, that should return true if they -are different.
-It is called when setting a new value to avoid doing anything -(such as notifying subscribers) if the value did not change.
-Parameters
a: T
First value to compare.
-b: T
Second value to compare.
+Type declaration
- (a, b): boolean
Returns boolean
true if a and b are considered different.
-Remarks
The default logic (when this option is not present) is to return true -if
-ais a function or an object, or ifaandbare different -according toObject.is.StoreOptions.equal takes precedence over notEqual if both -are defined.
-Deprecated
Use StoreOptions.equal instead
-
Remarks
The default logic (when this option is not present) is to return true +
Remarks
The default logic (when this option is not present) is to return true if
ais a function or an object, or ifaandbare different according toObject.is.StoreOptions.equal takes precedence over notEqual if both are defined.
-Deprecated
Use StoreOptions.equal instead
-Param: a
First value to compare.
-Param: b
Second value to compare.
-Returns
true if a and b are considered different.
-OptionalonUse A function that is called when the number of subscribers changes from 0 to 1 +
Deprecated
Use StoreOptions.equal instead
+OptionalonUse A function that is called when the number of subscribers changes from 0 to 1 (but not called when the number of subscribers changes from 1 to 2, ...). If it returns a function, that function will be called when the number of subscribers changes from 1 to 0.
-
\ No newline at end of file +Generated using TypeDoc
SubscribableStore | @amadeus-it-group/tansu Interface SubscribableStore<T>
Represents a store accepting registrations (subscribers) and "pushing" notifications on each and every store value change.
-Type Parameters
Hierarchy (view full)
- SubscribableStore
Index
Methods
Methods
subscribe
- subscribe(subscriber): Unsubscriber
- diff --git a/interfaces/SubscriberObject.html b/interfaces/SubscriberObject.html index 1de025f..fbd7e80 100644 --- a/interfaces/SubscriberObject.html +++ b/interfaces/SubscriberObject.html @@ -1,18 +1,14 @@ -
A method that makes it possible to register "interest" in store value changes over time. -It is called each and every time the store's value changes.
+SubscribableStore | @amadeus-it-group/tansu Interface SubscribableStore<T>
Represents a store accepting registrations (subscribers) and "pushing" notifications on each and every store value change.
+Type Parameters
Hierarchy (view full)
- SubscribableStore
Index
Methods
Methods
subscribe
- subscribe(subscriber): Unsubscriber
A method that makes it possible to register "interest" in store value changes over time. +It is called each and every time the store's value changes.
A registered subscriber is notified synchronously with the latest store value.
-Parameters
subscriber: Subscriber<T>
a subscriber in a form of a SubscriberFunction or a SubscriberObject. Returns a Unsubscriber (function or object with the
+unsubscribemethod) that can be used to unregister and stop receiving notifications of store value changes.Parameters
- subscriber: Subscriber<T>
a subscriber in a form of a SubscriberFunction or a SubscriberObject. Returns a Unsubscriber (function or object with the
unsubscribemethod) that can be used to unregister and stop receiving notifications of store value changes.
Returns Unsubscriber
The UnsubscribeFunction or UnsubscribeObject that can be used to unsubscribe (stop state change notifications).
-- subscriber: Subscriber<T>
\ No newline at end of file +Generated using TypeDoc
SubscriberObject | @amadeus-it-group/tansu diff --git a/interfaces/SyncDeriveOptions.html b/interfaces/SyncDeriveOptions.html index 8faca8f..f084f82 100644 --- a/interfaces/SyncDeriveOptions.html +++ b/interfaces/SyncDeriveOptions.html @@ -1,54 +1,29 @@ -Interface SubscriberObject<T>
interface SubscriberObject<T> {
    complete?: any;
    error?: any;
    next: SubscriberFunction<T>;
    pause: (() => void);
    resume: (() => void);
}Type Parameters
Properties
Optionalcompletecomplete?: anyUnused, only declared for compatibility with rxjs.
-Optionalerrorerror?: anyUnused, only declared for compatibility with rxjs.
-next
A store will call this method every time the store's state is changing.
-pause
pause: (() => void)A store will call this method when it knows that the value will be changed. +
SubscriberObject | @amadeus-it-group/tansu Interface SubscriberObject<T>
interface SubscriberObject<T> {
    complete?: any;
    error?: any;
    next: SubscriberFunction<T>;
    pause: (() => void);
    resume: (() => void);
}Type Parameters
Properties
Optionalcompletecomplete?: anyUnused, only declared for compatibility with rxjs.
+Optionalerrorerror?: anyUnused, only declared for compatibility with rxjs.
+next
A store will call this method every time the store's state is changing.
+pause
pause: (() => void)resume
resume: (() => void)A store will call this method if pause was called previously -and the value finally did not need to change.
-\ No newline at end of file +Generated using TypeDoc
SyncDeriveOptions | @amadeus-it-group/tansu Interface SyncDeriveOptions<T, S>
interface SyncDeriveOptions<T, S> {
    derive: SyncDeriveFn<T, S>;
    equal?: ((a, b) => boolean);
    notEqual?: ((a, b) => boolean);
}Type Parameters
Hierarchy
- Omit<StoreOptions<T>, "onUse">
- SyncDeriveOptions
Properties
derive
Optionalequalequal?: ((a, b) => boolean)Custom function to compare two values, that should return true if they +
SyncDeriveOptions | @amadeus-it-group/tansu diff --git a/interfaces/UnsubscribeObject.html b/interfaces/UnsubscribeObject.html index c2d8dab..3fcfbd9 100644 --- a/interfaces/UnsubscribeObject.html +++ b/interfaces/UnsubscribeObject.html @@ -1,5 +1,5 @@ -Interface SyncDeriveOptions<T, S>
interface SyncDeriveOptions<T, S> {
    derive: SyncDeriveFn<T, S>;
    equal?: ((a: T, b: T) => boolean);
    notEqual?: ((a: T, b: T) => boolean);
}Type Parameters
Hierarchy
- Omit<StoreOptions<T>, "onUse">
- SyncDeriveOptions
Properties
derive
OptionalequalCustom function to compare two values, that should return true if they are equal.
It is called when setting a new value to avoid doing anything (such as notifying subscribers) if the value did not change.
-Type declaration
- (a, b): boolean
Custom function to compare two values, that should return true if they -are equal.
-It is called when setting a new value to avoid doing anything -(such as notifying subscribers) if the value did not change.
-Parameters
a: T
First value to compare.
-b: T
Second value to compare.
+Type declaration
- (a, b): boolean
Returns boolean
true if a and b are considered equal.
-
Remarks
The default logic (when this option is not present) is to return false +
Remarks
The default logic (when this option is not present) is to return false if
ais a function or an object, or ifaandbare different according toObject.is.equal takes precedence over notEqual if both are defined.
-Param: a
First value to compare.
-Param: b
Second value to compare.
-Returns
true if a and b are considered equal.
-OptionalnotEqual notEqual?: ((a, b) => boolean) Custom function to compare two values, that should return true if they +
OptionalnotEqual Custom function to compare two values, that should return true if they are different.
It is called when setting a new value to avoid doing anything (such as notifying subscribers) if the value did not change.
-Type declaration
- (a, b): boolean
Custom function to compare two values, that should return true if they -are different.
-It is called when setting a new value to avoid doing anything -(such as notifying subscribers) if the value did not change.
-Parameters
a: T
First value to compare.
-b: T
Second value to compare.
+Type declaration
- (a, b): boolean
Returns boolean
true if a and b are considered different.
-Remarks
The default logic (when this option is not present) is to return true -if
-ais a function or an object, or ifaandbare different -according toObject.is.StoreOptions.equal takes precedence over notEqual if both -are defined.
-Deprecated
Use StoreOptions.equal instead
-
Remarks
The default logic (when this option is not present) is to return true +
Remarks
The default logic (when this option is not present) is to return true if
ais a function or an object, or ifaandbare different according toObject.is.StoreOptions.equal takes precedence over notEqual if both are defined.
-Deprecated
Use StoreOptions.equal instead
-Param: a
First value to compare.
-Param: b
Second value to compare.
-Returns
true if a and b are considered different.
-
\ No newline at end of file +Generated using TypeDoc
Deprecated
Use StoreOptions.equal instead
+
UnsubscribeObject | @amadeus-it-group/tansu diff --git a/interfaces/Writable-1.html b/interfaces/Writable-1.html index 29b7e51..eac12cc 100644 --- a/interfaces/Writable-1.html +++ b/interfaces/Writable-1.html @@ -1,17 +1,20 @@ -Interface UnsubscribeObject
An object with the
unsubscribemethod. +UnsubscribeObject | @amadeus-it-group/tansu Interface UnsubscribeObject
An object with the
-unsubscribemethod. Subscribable stores might choose to return such object instead of directly returning UnsubscribeFunction from a subscription call.Index
Properties
Properties
unsubscribe
A method that acts as the UnsubscribeFunction.
-\ No newline at end of file +Generated using TypeDoc
Index
Properties
Properties
unsubscribe
A method that acts as the UnsubscribeFunction.
+Writable | @amadeus-it-group/tansu Interface Writable<T, U>
Builds on top of Readable and represents a store that can be manipulated from "outside": anyone with a reference to writable store can either update or completely replace state of a given store.
-Example
-// reset counter's store value to 0 by using the {@link Writable.set} method
counterStore.set(0);
// increment counter's store value by using the {@link Writable.update} method
counterStore.update(currentValue => currentValue + 1); -interface Writable<T, U> {
    [observable](): Readable<T>;
    set(value): void;
    subscribe(subscriber): UnsubscribeFunction & UnsubscribeObject;
    update(updater): void;
}Type Parameters
T
U = T
Hierarchy (view full)
Index
Methods
Methods
[observable]
set
- set(value): void
Replaces store's state with the provided value.
-Parameters
value: U
value to be used as the new state of a store.
-
Returns void
subscribe
- subscribe(subscriber): UnsubscribeFunction & UnsubscribeObject
- diff --git a/interfaces/WritableSignal.html b/interfaces/WritableSignal.html index a430c08..6e1269d 100644 --- a/interfaces/WritableSignal.html +++ b/interfaces/WritableSignal.html @@ -1,17 +1,19 @@ -
A method that makes it possible to register "interest" in store value changes over time. -It is called each and every time the store's value changes.
+Writable | @amadeus-it-group/tansu Interface Writable<T, U>
Builds on top of Readable and represents a store that can be manipulated from "outside": anyone with a reference to writable store can either update or completely replace state of a given store.
+interface Writable<T, U> {
    [observable](): Readable<T>;
    get(): T;
    set(value: U): void;
    subscribe(subscriber: Subscriber<T>): UnsubscribeFunction & UnsubscribeObject;
    update(updater: Updater<T, U>): void;
}Type Parameters
- T
- U = T
Hierarchy (view full)
Index
Methods
Methods
[observable]
get
set
- set(value): void
Replaces store's state with the provided value.
+Parameters
- value: U
value to be used as the new state of a store.
+
Returns void
- value: U
subscribe
- subscribe(subscriber): UnsubscribeFunction & UnsubscribeObject
A method that makes it possible to register "interest" in store value changes over time. +It is called each and every time the store's value changes.
A registered subscriber is notified synchronously with the latest store value.
-Parameters
subscriber: Subscriber<T>
a subscriber in a form of a SubscriberFunction or a SubscriberObject. Returns a Unsubscriber (function or object with the
+unsubscribemethod) that can be used to unregister and stop receiving notifications of store value changes.Parameters
- subscriber: Subscriber<T>
a subscriber in a form of a SubscriberFunction or a SubscriberObject. Returns a Unsubscriber (function or object with the
unsubscribemethod) that can be used to unregister and stop receiving notifications of store value changes.
Returns UnsubscribeFunction & UnsubscribeObject
The UnsubscribeFunction or UnsubscribeObject that can be used to unsubscribe (stop state change notifications).
-- subscriber: Subscriber<T>
update
\ No newline at end of file +Generated using TypeDoc
update
WritableSignal | @amadeus-it-group/tansu Interface WritableSignal<T, U>
diff --git a/media/DEVELOPER.md b/media/DEVELOPER.md new file mode 100644 index 0000000..dadf677 --- /dev/null +++ b/media/DEVELOPER.md @@ -0,0 +1,9 @@ +Run: + + - `npm test` to execute unit tests. + - `npm run tdd` or `npm run tdd:ui` to execute unit tests in the TDD mode (tests are re-run on each change). + - `npm run build` to build the lib + - `npm run format:check` to check that files are correctly formatted + - `npm run format:fix` to reformat files + - `npm run api` to run the api-extractor + - `npm run docs` to run api-documenter based on the api-extractor result. It will generate the tsdoc markdown files. diff --git a/modules.html b/modules.html index 7b08b90..f693b7c 100644 --- a/modules.html +++ b/modules.html @@ -1,39 +1,40 @@ -Represents a store that implements both ReadableSignal and Writable. +
WritableSignal | @amadeus-it-group/tansu Interface WritableSignal<T, U>
Represents a store that implements both ReadableSignal and Writable. This is the type of objects returned by writable.
-interface WritableSignal<T, U> {
    [observable](): Readable<T>;
    set(value): void;
    subscribe(subscriber): UnsubscribeFunction & UnsubscribeObject;
    update(updater): void;
    (): T;
}Type Parameters
T
U = T
Hierarchy (view full)
- ReadableSignal<T>
- Writable<T, U>
- WritableSignal
Index
Methods
Methods
[observable]
set
- set(value): void
Replaces store's state with the provided value.
-Parameters
value: U
value to be used as the new state of a store.
-
Returns void
subscribe
- subscribe(subscriber): UnsubscribeFunction & UnsubscribeObject
A method that makes it possible to register "interest" in store value changes over time. -It is called each and every time the store's value changes.
+
interface WritableSignal<T, U> {
    [observable](): Readable<T>;
    get(): T;
    set(value: U): void;
    subscribe(subscriber: Subscriber<T>): UnsubscribeFunction & UnsubscribeObject;
    update(updater: Updater<T, U>): void;
    (): T;
}Type Parameters
- T
- U = T
Hierarchy (view full)
- ReadableSignal<T>
- Writable<T, U>
- WritableSignal
Index
Methods
Methods
[observable]
get
set
- set(value): void
Replaces store's state with the provided value.
+Parameters
- value: U
value to be used as the new state of a store.
+
Returns void
- value: U
subscribe
- subscribe(subscriber): UnsubscribeFunction & UnsubscribeObject
A method that makes it possible to register "interest" in store value changes over time. +It is called each and every time the store's value changes.
A registered subscriber is notified synchronously with the latest store value.
-Parameters
subscriber: Subscriber<T>
a subscriber in a form of a SubscriberFunction or a SubscriberObject. Returns a Unsubscriber (function or object with the
+unsubscribemethod) that can be used to unregister and stop receiving notifications of store value changes.Parameters
- subscriber: Subscriber<T>
a subscriber in a form of a SubscriberFunction or a SubscriberObject. Returns a Unsubscriber (function or object with the
unsubscribemethod) that can be used to unregister and stop receiving notifications of store value changes.
Returns UnsubscribeFunction & UnsubscribeObject
The UnsubscribeFunction or UnsubscribeObject that can be used to unsubscribe (stop state change notifications).
-- subscriber: Subscriber<T>
update
\ No newline at end of file +Generated using TypeDoc
update
@amadeus-it-group/tansu diff --git a/types/AsyncDeriveFn.html b/types/AsyncDeriveFn.html index dec40a9..ef7c585 100644 --- a/types/AsyncDeriveFn.html +++ b/types/AsyncDeriveFn.html @@ -1 +1 @@ -@amadeus-it-group/tansu
tansu is a lightweight, push-based state management library. +
@amadeus-it-group/tansu @amadeus-it-group/tansu
tansu is a lightweight, push-based state management library. It borrows the ideas and APIs originally designed and implemented by Svelte stores.
-Index
Classes
Interfaces
Type Aliases
Variables
Functions
\ No newline at end of file +Generated using TypeDoc
Index
Classes
Interfaces
Type Aliases
Variables
Functions
AsyncDeriveFn | @amadeus-it-group/tansu Type alias AsyncDeriveFn<T, S>
Type Parameters
Type declaration
- (values, set): Unsubscriber | void
Parameters
values: StoresInputValues<S>
set: OnUseArgument<T>
Returns Unsubscriber | void
\ No newline at end of file +Generated using TypeDoc
AsyncDeriveFn | @amadeus-it-group/tansu diff --git a/types/OnUseFn.html b/types/OnUseFn.html index b344350..6da5857 100644 --- a/types/OnUseFn.html +++ b/types/OnUseFn.html @@ -1,4 +1,4 @@ -Type Alias AsyncDeriveFn<T, S>
Type Parameters
OnUseFn | @amadeus-it-group/tansu diff --git a/types/StoreInput.html b/types/StoreInput.html index 1c50e53..11ea2ab 100644 --- a/types/StoreInput.html +++ b/types/StoreInput.html @@ -1,2 +1,2 @@ -Type alias OnUseFn<T>
Type of a function that is called when the number of subscribers changes from 0 to 1 +
OnUseFn | @amadeus-it-group/tansu Type Alias OnUseFn<T>
Type of a function that is called when the number of subscribers changes from 0 to 1 (but not called when the number of subscribers changes from 1 to 2, ...).
If it returns a function, that function will be called when the number of subscribers changes from 1 to 0.
-Type Parameters
Type declaration
- (arg): void | Unsubscriber
Parameters
arg: OnUseArgument<T>
Returns void | Unsubscriber
\ No newline at end of file +Generated using TypeDoc
Type Parameters
StoreInput | @amadeus-it-group/tansu Type alias StoreInput<T>
Valid types that can be considered as a store.
-Type Parameters
\ No newline at end of file +Generated using TypeDoc
StoreInput | @amadeus-it-group/tansu diff --git a/types/StoresInput.html b/types/StoresInput.html index c3c011c..5c49264 100644 --- a/types/StoresInput.html +++ b/types/StoresInput.html @@ -1,2 +1,2 @@ -Type Alias StoreInput<T>
Valid types that can be considered as a store.
+Type Parameters
StoresInput | @amadeus-it-group/tansu Type alias StoresInput
Either a single StoreInput or a read-only array of at least one StoreInput.
-\ No newline at end of file +Generated using TypeDoc
StoresInput | @amadeus-it-group/tansu diff --git a/types/StoresInputValues.html b/types/StoresInputValues.html index e6d3a0d..54e8bc7 100644 --- a/types/StoresInputValues.html +++ b/types/StoresInputValues.html @@ -1,6 +1,6 @@ -Type Alias StoresInput
Either a single StoreInput or a read-only array of at least one StoreInput.
+StoresInputValues | @amadeus-it-group/tansu diff --git a/types/Subscriber.html b/types/Subscriber.html index 6f5d7aa..9799854 100644 --- a/types/Subscriber.html +++ b/types/Subscriber.html @@ -1,6 +1,6 @@ -Type alias StoresInputValues<S>
StoresInput Values<S>: S extends StoreInput<infer T>
    ? T
    : {
        [K in keyof S]: S[K] extends StoreInput<infer T>
            ? T
            : never
    }Extracts the types of the values of the stores from a type extending StoresInput.
-Type Parameters
Remarks
If the type given as a parameter is a single StoreInput, the type of the value +
StoresInputValues | @amadeus-it-group/tansu Type Alias StoresInputValues<S>
StoresInput Values<S>: S extends StoreInput<infer T>
    ? T
    : {
        [K in keyof S]: S[K] extends StoreInput<infer T>
            ? T
            : never
    }Extracts the types of the values of the stores from a type extending StoresInput.
+Type Parameters
Remarks
If the type given as a parameter is a single StoreInput, the type of the value of that StoreInput is returned.
If the type given as a parameter is one of an array of StoreInput, the returned type is the type of an array containing the value of each store in the same order.
-\ No newline at end of file +Generated using TypeDoc
Subscriber | @amadeus-it-group/tansu diff --git a/types/SubscriberFunction.html b/types/SubscriberFunction.html index e2f0e0a..5063e3b 100644 --- a/types/SubscriberFunction.html +++ b/types/SubscriberFunction.html @@ -1,2 +1,2 @@ -Type alias Subscriber<T>
Expresses interest in store value changes over time. It can be either:
+Subscriber | @amadeus-it-group/tansu Type Alias Subscriber<T>
Subscriber<T>:
    | SubscriberFunction<T>
    | Partial<SubscriberObject<T>>
    | null
    | undefinedExpresses interest in store value changes over time. It can be either:
- a callback function: SubscriberFunction;
- a partial observer: SubscriberObject.
Type Parameters
\ No newline at end of file +Generated using TypeDoc
Type Parameters
SubscriberFunction | @amadeus-it-group/tansu Type alias SubscriberFunction<T>
A callback invoked when a store value changes. It is called with the latest value of a given store.
-Type Parameters
Type declaration
- (value): void
Parameters
value: T
Returns void
\ No newline at end of file +Generated using TypeDoc
SubscriberFunction | @amadeus-it-group/tansu diff --git a/types/SyncDeriveFn.html b/types/SyncDeriveFn.html index 5976411..1495dc4 100644 --- a/types/SyncDeriveFn.html +++ b/types/SyncDeriveFn.html @@ -1 +1 @@ -Type Alias SubscriberFunction<T>
A callback invoked when a store value changes. It is called with the latest value of a given store.
+Type Parameters
SyncDeriveFn | @amadeus-it-group/tansu \ No newline at end of file +Generated using TypeDoc
SyncDeriveFn | @amadeus-it-group/tansu diff --git a/types/UnsubscribeFunction.html b/types/UnsubscribeFunction.html index 0101a8a..7866694 100644 --- a/types/UnsubscribeFunction.html +++ b/types/UnsubscribeFunction.html @@ -1,2 +1,2 @@ -Type Alias SyncDeriveFn<T, S>
Type Parameters
UnsubscribeFunction | @amadeus-it-group/tansu Type alias UnsubscribeFunction
UnsubscribeFunction: (() => void) A function to unsubscribe from value change notifications.
-Type declaration
- (): void
Returns void
\ No newline at end of file +Generated using TypeDoc
UnsubscribeFunction | @amadeus-it-group/tansu diff --git a/types/Unsubscriber.html b/types/Unsubscriber.html index 31f3e47..be34bb4 100644 --- a/types/Unsubscriber.html +++ b/types/Unsubscriber.html @@ -1 +1 @@ -Type Alias UnsubscribeFunction
UnsubscribeFunction: (() => void) A function to unsubscribe from value change notifications.
+Unsubscriber | @amadeus-it-group/tansu Type alias Unsubscriber
\ No newline at end of file +Generated using TypeDoc
Unsubscriber | @amadeus-it-group/tansu diff --git a/types/Updater.html b/types/Updater.html index 49c0a1d..e22a7e6 100644 --- a/types/Updater.html +++ b/types/Updater.html @@ -1,2 +1,2 @@ -Type Alias Unsubscriber
Updater | @amadeus-it-group/tansu \ No newline at end of file +Generated using TypeDoc
Updater | @amadeus-it-group/tansu diff --git a/variables/symbolObservable.html b/variables/symbolObservable.html index a0c586e..a4ad656 100644 --- a/variables/symbolObservable.html +++ b/variables/symbolObservable.html @@ -1,2 +1,2 @@ -symbolObservable | @amadeus-it-group/tansu Variable symbolObservable
ConstsymbolObservable: typeof Symbol.observable = ... Symbol used in InteropObservable allowing any object to expose an observable.
-\ No newline at end of file +Generated using TypeDoc
symbolObservable | @amadeus-it-group/tansu Variable symbolObservable
ConstsymbolObservable: typeof Symbol.observable = ... Symbol used in InteropObservable allowing any object to expose an observable.
+
- as
- as
Base class that can be extended to easily create a custom Readable store.
-Example
-