HyperFrontend logo
← Back to @hyperfrontend/state-machine
@hyperfrontend/state-machine/models

models

Shared type definitions for state-machine state, actions, and reducers.

This entry point re-exports the cross-cutting types consumed by the runtime modules (store, reducer, selectors, state-change). Consumers writing their own action handlers or reducers import from here to stay aligned with the shapes the rest of the library expects, without having to dig into module-private files.

API Reference§

◈ Interfaces

§interface

Action

Base action with a type discriminator
Properties
§type:stringAction type identifier
View source →
§interface

DerivedState

Derived state computed from core state flags
Properties
§cancelled:booleanOperation was cancelled
§done:booleanOperation has completed
§failed:booleanOperation failed
§inProgress:booleanOperation is in progress
§notStarted:booleanOperation has not started
§paused:booleanOperation is paused
§restarting:booleanOperation is restarting
§retrying:booleanOperation is retrying
§successful:booleanOperation completed successfully
View source →
§interface

Handlers

Map of action type constants to their handler functions
Properties
§process cancelled:(state: State, action: { payload: unknown; type: string }) => StateHandler for cancel action
§process completed successfully:(state: State, action: { payload: unknown; type: string }) => StateHandler for success action
§process failed:(state: State, action: { error: any; type: string }) => StateHandler for fail action
§process paused:(state: State, action: { payload: unknown; type: string }) => StateHandler for pause action
§process started:(state: State, action: { payload: unknown; type: string }) => StateHandler for start action
View source →
§interface

State

Core state machine state flags
Properties
§fail:booleanWhether the operation failed
§halt:booleanWhether the operation is halted
§inProgress:booleanWhether the operation is currently in progress
§success:booleanWhether the operation completed successfully
View source →

◆ Types

§type

Event

Event name type derived from the event constant object
type Event = indexedAccess
View source →
§type

StateDeriver

Function that derives full DerivedState from State
type StateDeriver = (state: State) => DerivedState
View source →
§type

StateStatusDeriver

Function that derives a single status boolean from state
type StateStatusDeriver = (state: State) => boolean
View source →

● Variables