Interface DataStoreController<TFields>

The store contract the standalone runtime implements -- useSyncExternalStore-compatible without importing React.

interface DataStoreController<TFields> {
    addPendingTransition(
        fieldsPatch: DeepPartial<TFields> | undefined,
        infoPatch: DeepPartial<DataInfo<TFields>> | undefined,
    ): symbol;
    commitAuthoritative(
        fieldsPatch: DeepPartial<TFields> | undefined,
        infoPatch: DeepPartial<DataInfo<TFields>> | undefined,
    ): void;
    getAuthoritativeState(): DataState<TFields>;
    getSnapshot(): DataState<TFields>;
    removePendingTransition(id: symbol): void;
    subscribe(listener: () => void): () => void;
}

Type Parameters

TFields

Hierarchy (View Summary)

DataStore<TFields>
- DataStoreController

Index

Methods

addPendingTransition commitAuthoritative getAuthoritativeState getSnapshot removePendingTransition subscribe

Methods

addPendingTransition

addPendingTransition(
fieldsPatch: DeepPartial<TFields> | undefined,
infoPatch: DeepPartial<DataInfo<TFields>> | undefined,
): symbol
Adds a pending optimistic transition; the visible snapshot reflects it immediately.
Parameters
- fieldsPatch: DeepPartial<TFields> | undefined
- infoPatch: DeepPartial<DataInfo<TFields>> | undefined
Returns symbol
- Defined in src/runtime/store.ts:35

commitAuthoritative

commitAuthoritative(
fieldsPatch: DeepPartial<TFields> | undefined,
infoPatch: DeepPartial<DataInfo<TFields>> | undefined,
): void
Commits a patch directly onto authoritative state (getter/subscription- style updates, and a mutator's final settle). Always folds onto the CURRENT authoritative state, never a snapshot captured earlier.
Parameters
- fieldsPatch: DeepPartial<TFields> | undefined
- infoPatch: DeepPartial<DataInfo<TFields>> | undefined
Returns void
- Defined in src/runtime/store.ts:30

getAuthoritativeState

getAuthoritativeState(): DataState<TFields>
The current authoritative state, independent of any pending optimistic transitions.

Returns DataState<TFields>
- Defined in src/runtime/store.ts:42

getSnapshot

getSnapshot(): DataState<TFields>
Returns the current, immutable DataState snapshot.

Returns DataState<TFields>
Inherited from DataStore.getSnapshot
- Defined in src/core/types.ts:185

removePendingTransition

removePendingTransition(id: symbol): void
Removes a pending transition by id (its operation settled, success or failure either way).
Parameters
- id: symbol
Returns void
- Defined in src/runtime/store.ts:40

subscribe(listener: () => void): () => void
Registers listener to be called after every committed state change; returns an unsubscribe function.
Parameters
- listener: () => void
Returns () => void
Inherited from DataStore.subscribe
- Defined in src/core/types.ts:187