A lightweight, composable and explicit reactivity system.
It does not convert the value with Object.defineProperty
nor Proxy
. Keeping
everything as plain JavaScript value makes it easier to work with other libraries and easier for the
JavaScript engine to optimize.
import { writable, readable, type Readable } from "@embra/reactivity";
const count$ = writable(0);
count$.set(1);
const [count2$, setCount] = readable(0);
setCount(1);
Unlike signal-based libraries, @embra/reactivity
does not automatically track dependencies.
You explicitly define what to watch and how to react to changes. This is easier to reason about
dependencies and also reduce the cost of complex implicit dependency calculation.
With React hook-like API, computations can be pure functions which is more compatible with general non-reactive functions.
import { writable, derive } from "@embra/reactivity";
const count$ = writable(0);
const isPositive = (value: number): boolean => value > 0;
const positiveCount$ = derive(count$, isPositive);
Dynamic dependencies can be collected using get
in compute
or
watch
.
import { writable, compute, watch } from "@embra/reactivity";
const count$ = writable(0);
const doubleCount$ = compute(get => get(count$) * 2);
watch(get => {
const count = get(count$);
console.log(`Count is ${count}, double is ${get(doubleCount$)}`);
});
In practice, one of the biggest problems we face with reactivity libraries is the lifecycle management of
reactive values. @embra/reactivity
provides a zero-cost ownership model that allows you to
create reactive values with explicit ownership.
By default, created reactive values are with type OwnedReadable
or
OwnedWritable
, which exposes a dispose()
method to clean up the value and its
dependencies. When passing the reactive value to a function, you can use Readable
or
Writable
types to hide the dispose()
method, ensuring that the value is not
disposed of accidentally.
import { writable, readable, type Readable, type OwnedWritable } from "@embra/reactivity";
const count$: OwnedWritable<number> = writable(0);
count$.set(1);
// Hide the setter by typing
function logCount(count$: Readable<number>) {
count$.subscribe(console.log);
// @ts-expect-error
count$.set(2);
}
logCount(count$);
// Hide the setter in runtime
const [count2$, setCount] = readable(0);
setCount(1);
// @ts-expect-error
count2$.set(2);
In the days of Flux model, we often used a single store to hold the state and actions to mutate the state. This was nice for reasoning about the state, but it also introduced a lot of boilerplate code.
Later on, a pattern with state and action glued together was introduced, like redux-actions
.
@embra/reactivity
takes this a step further by providing a more simple and flexible
abstraction of state and actions.
In the following example, we create a Writable count$
which looks like a
Writable<number>
, but internally it is derived from a larger application state
appState$
. This allows other modules to depend on a
Writable<number>
without knowing the details of the application state.
import { writable, derive, toWritable, trace } from "@embra/reactivity";
const appState$ = writable({
count: 0,
user: null,
});
const count$ = toWritable(
derive(appState$, state => state.count),
count => appState$.set({ ...appState$.value, count }),
);
// when debugging, you can trace the reactive value
trace(count$);
@embra/reactivity
is designed to be framework agnostic. It can be used with any framework or
library that supports JavaScript. It also provides first-class support for React.
import { writable } from "@embra/reactivity";
import { useDerived, useCombined } from "@embra/reactivity/react";
const count$ = writable(0);
function Counter({ count$ }) {
const count = useDerived(count$);
return (
<div>
<button onClick={() => count$.set(count - 1)}>-</button>
<span>{count}</span>
<button onClick={() => count$.set(count + 1)}>+</button>
</div>
);
}
npm add @embra/reactivity
@embra/reactivity
provides a trace()
function to help debug reactive values and
watches. It tracks value and dependency changes and logs them to the console.
import { trace, writable, watch } from "@embra/reactivity";
const count$ = writable(0);
// trace a reactive value
trace(count$);
// trace a watch function
watch(trace(get => get(count$)));
count$.set(1);
@embra/reactivity
supports Chrome DevTools
custom formatters. You may enable it by checking the "Enable custom formatters" option in the "Console"
section of DevTools general settings.
It is enabled in development by default. You can also enable it manually by calling
customFormatter()
.
import { customFormatter } from "@embra/reactivity";
customFormatter();