Strata - v1.4.10
    Preparing search index...

    Interface GameStoreApi<T>

    Store API with temporal state access for undo/redo.

    interface GameStoreApi<T> {
        getState: () => GameStore<T>;
        setState: {
            (
                partial:
                    | GameStore<T>
                    | Partial<GameStore<T>>
                    | ((state: GameStore) => GameStore<T> | Partial<GameStore<T>>),
                replace?: false,
            ): void;
            (
                state: GameStore<T> | ((state: GameStore) => GameStore),
                replace: true,
            ): void;
        };
        subscribe: (
            listener: (state: GameStore, prevState: GameStore) => void,
        ) => () => void;
        temporal: StoreApi<TemporalState<GameStore<T>>>;
        (): GameStore<T>;
        <U>(selector: (state: GameStore<T>) => U): U;
    }

    Type Parameters

    • T
    Index

    Properties

    getState setState subscribe temporal

    Properties

    getState: () => GameStore<T>

    Get current state snapshot without subscribing.

    setState: {
        (
            partial:
                | GameStore<T>
                | Partial<GameStore<T>>
                | ((state: GameStore) => GameStore<T> | Partial<GameStore<T>>),
            replace?: false,
        ): void;
        (
            state: GameStore<T> | ((state: GameStore) => GameStore),
            replace: true,
        ): void;
    }

    Update state imperatively (not recommended in React).

    subscribe: (
        listener: (state: GameStore, prevState: GameStore) => void,
    ) => () => void

    Subscribe to state changes.

    temporal: StoreApi<TemporalState<GameStore<T>>>

    Access to temporal (undo/redo) state.

    Settings

    Member Visibility

    On This Page

    Properties