Atomic state management with explicit store boundaries and serializable snapshots.
atomcreateAtomStoredefineAtomStoreSnapshotgetCurrentStorewithStoreAppIdAtomStoreAtomStoreSnapshotAtomStoreSnapshotSchemaAtomStoreSnapshotValueAtomUpdateDerivedAtomGetterInferPrimitiveAtomValuePrimitiveAtomReadableAtomReadableAtomRefWritableAtomWritableAtomRefCreate primitive or derived atomic state units.
type Getter = <T>(atom: ReadableAtom<T>) => T;
type NonFunction<T> = T extends (...args: never[]) => unknown ? never : T;
declare function atom<T>(key: string, read: (get: Getter) => T): DerivedAtom<T>;
declare function atom<T>(key: string, initialValue: NonFunction<T>): PrimitiveAtom<T>;Returns:A PrimitiveAtom<T> or DerivedAtom<T>.
| Name | Type | Description |
|---|---|---|
key | string | Stable atom key used for lookup and debugging. |
defaultValue / read | T | ((get: Getter) => T) | Primitive default value or derived read function. |
Create an atom store instance for a Dathra application or request boundary.
declare function createAtomStore(options: {
appId: AppId;
values?: Iterable<readonly [WritableAtom<unknown>, unknown]>;
}): AtomStore;Returns:An AtomStore instance.
Run code within a store boundary and read the current active store.
declare function getCurrentStore(): AtomStore | undefined;
declare function withStore<T>(store: AtomStore, render: () => T): T;Returns:withStore returns the callback result; getCurrentStore returns the active store or undefined.
| Name | Type | Description |
|---|---|---|
store | AtomStore | Store to bind while render executes. |
render | () => T | Callback that runs with the store as current context. |
Define a serializable snapshot schema for a selected set of primitive atoms.
type AtomStoreSnapshotSchema = Record<string, PrimitiveAtom<unknown>>;
type InferPrimitiveAtomValue<T> = T extends PrimitiveAtom<infer U> ? U : never;
type AtomStoreSnapshotValue<S extends AtomStoreSnapshotSchema> = {
readonly [K in keyof S]: InferPrimitiveAtomValue<S[K]>;
};
interface AtomStoreSnapshot<S extends AtomStoreSnapshotSchema> {
readonly schema: Readonly<S>;
serialize(store: AtomStore): AtomStoreSnapshotValue<S>;
values(snapshot: AtomStoreSnapshotValue<S>): Iterable<readonly [S[keyof S], unknown]>;
hydrate(store: AtomStore, snapshot: AtomStoreSnapshotValue<S>): void;
}
declare function defineAtomStoreSnapshot<const S extends AtomStoreSnapshotSchema>(schema: S): AtomStoreSnapshot<S>;Returns:An AtomStoreSnapshot<S> with serialize, values, and hydrate helpers.
| Name | Type | Description |
|---|---|---|
schema | S extends AtomStoreSnapshotSchema | Object mapping snapshot field names to primitive atoms. |