@relax-state/store

Store runtime for the Relax framework. Manages reactive state values, computed caching, and effects.

Installation

npm install @relax-state/store
# or
pnpm add @relax-state/store

Requires @relax-state/core for state creation (state, computed).

Quick Usage

import { state, computed } from '@relax-state/core';
import { createStore } from '@relax-state/store';

const store = createStore();
const count = state(0);
const doubled = computed({ get: (get) => get(count) * 2 });

// Read state
console.log(store.get(count)); // 0
console.log(store.get(doubled)); // 0

// Update state
store.set(count, 5);
console.log(store.get(count)); // 5
console.log(store.get(doubled)); // 10

// Subscribe to changes
store.effect(count, ({ oldValue, newValue }) => {
  console.log(`Count: ${oldValue} -> ${newValue}`);
});

API

createStore(): Store

Creates a new store instance. Use this when you need multiple isolated stores.

import { createStore } from '@relax-state/store';

const store = createStore();

getRuntimeStore() / setRuntimeStore(store) / resetRuntimeStore()

Runtime store used by actions and React (e.g. RelaxProvider). Call setRuntimeStore(store) before running actions when not using React; in React, the provider sets it from context.

import { createStore, setRuntimeStore, getRuntimeStore } from '@relax-state/store';
import { state, action } from '@relax-state/core';

const store = createStore();
setRuntimeStore(store);
const count = state(0);
const increment = action((payload: { n: number }, s) => s.set(count, s.get(count) + payload.n), { name: 'increment' });
increment({ n: 5 });
console.log(getRuntimeStore().get(count)); // 5

Store

The store class. Instances provide:

• get(state) – Read state value (computes and caches derived values)
• set(state, value) – Update state and trigger effects
• effect(state, fn) – Subscribe to state changes; returns unsubscribe function
• clearEffect(state, fn) – Remove an effect callback

import type { Store } from '@relax-state/store';

License

ISC