IState

Interface representing the runtime state management API. Provides methods to get, set, and clear the state.

Properties

getState

getState: () => Promise<T>
Copy

Retrieves the current state value. Applies any configured middleware or custom getState logic from the schema.

setState

setState: (dispatchFn: (prevState: T) => Promise<T>) => Promise<T>
Copy

Updates the state using a dispatch function that computes the new state from the previous state. Applies any configured middleware or custom setState logic from the schema.

clearState

clearState: () => Promise<T>
Copy

Resets the state to its initial default value. Reverts to the value provided by getDefaultState in the schema.