@philiprehberger/tiny-store
v0.1.4582 downloadsMIT
Reactive state container in under 1KB — framework agnostic
$
npm install @philiprehberger/tiny-storeREADME
@philiprehberger/tiny-store
Reactive state container in under 1KB — framework agnostic
Installation
npm install @philiprehberger/tiny-store
Usage
import { createStore, computed, batch } from '@philiprehberger/tiny-store';
// Create a store
const count = createStore(0);
count.get(); // 0
// Subscribe to changes
const unsubscribe = count.subscribe((value, previous) => {
console.log(`${previous} -> ${value}`);
});
count.set(1); // logs: 0 -> 1
count.update((n) => n + 1); // logs: 1 -> 2
// Derived stores
const doubled = computed([count], (n) => n * 2);
doubled.get(); // 4
// Batch updates — subscribers notified once per set, after batch completes
batch(() => {
count.set(10);
count.set(20);
});
unsubscribe();
API
createStore<T>(initial: T): Store<T>
Create a reactive store with an initial value.
| Method | Description |
|---|---|
get() | Return the current value |
set(value) | Replace the value and notify subscribers (skipped if Object.is equal) |
update(fn) | Update via callback: store.update(n => n + 1) |
subscribe(listener) | Register a (value, previous) => void listener; returns an unsubscribe function |
computed<T>(stores, fn): ComputedStore<T>
Create a read-only derived store that recomputes whenever any source store changes. Subscribers are only notified when the computed result actually differs (Object.is).
batch(fn: () => void): void
Execute fn synchronously, deferring all subscriber notifications until the batch completes. Supports nesting. If fn throws, pending notifications are still flushed.
Development
npm install
npm run build
npm run typecheck
npm test
Support
If you find this project useful: