@alwatr/fsm
Advanced tools
A robust TypeScript library for implementing Flux (Finite) State Machines, enabling clear and organized management of application state and transitions.
A robust TypeScript library for implementing Flux (Finite) State Machines, enabling clear and organized management of application state and transitions.
@alwatr/observable for reactive state updates.npm install @alwatr/fsm
import {FluxStateMachineBase} from '@alwatr/fsm';
// Define your states and events
type MyState = 'idle' | 'loading' | 'success' | 'error';
type MyEvent = 'fetch' | 'success' | 'error';
class MyStateMachine extends FluxStateMachineBase<MyState, MyEvent> {
constructor() {
super({
name: 'my-state-machine',
initialState: 'idle',
});
// Define state transitions
this.stateRecord_ = {
idle: {
fetch: 'loading',
},
loading: {
success: 'success',
error: 'error',
},
success: {}, // Terminal state
error: {}, // Terminal state
};
// Define actions (optional)
this.actionRecord_ = {
'on_fetch': this.handleFetch,
'on_success': this.handleSuccess,
'on_error': this.handleError,
};
}
// ... (Implement your action methods: handleFetch, handleSuccess, handleError)
// Trigger a state transition
fetchData() {
this.transition_('fetch');
}
}
FluxStateMachineBase<S extends string, E extends string>constructor(config: {name: string; loggerPrefix?: string; initialState: S}):
config.name: The name of the state machine (used for logging).config.loggerPrefix: Optional prefix for log messages.config.initialState: The initial state of the machine.stateRecord_: StateRecord<S, E>: Defines the states and their possible transitions based on events.
actionRecord_: ActionRecord<S, E>: Binds action names to class methods for execution during transitions.
transition_(event: E): Triggers a state transition based on the provided event.
shouldTransition_(_eventDetail: StateEventDetail<S, E>): MaybePromise<boolean>: (Optional) Allows you to define custom conditions for transitions.
postTransition__(eventDetail: StateEventDetail<S, E>): Executes actions associated with state transitions and events.
execAction__(name: ActionName<S, E>, eventDetail: StateEventDetail<S, E>): Executes a specific action if defined in the actionRecord_.
resetToInitialState_(): Resets the machine to its initial state without notifying subscribers.
The following companies, organizations, and individuals support flux ongoing maintenance and development. Become a Sponsor to get your logo on our README and website.
Contributions are welcome! Please read our contribution guidelines before submitting a pull request.
This project is licensed under the AGPL-3.0 License.
3.1.1 (2024-09-29)
FAQs
A robust TypeScript library for implementing Flux (Finite) State Machines, enabling clear and organized management of application state and transitions.
The npm package @alwatr/fsm receives a total of 92 weekly downloads. As such, @alwatr/fsm popularity was classified as not popular.
We found that @alwatr/fsm demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."
