API
Этот раздел описывает публичные точки входа, runtime exports и основные типы пакетов lite-fsm. Краткие справочники также доступны в репозитории: API-CHEATSHEET.md и TYPES-CHEATSHEET.md.
Entry points
| Импорт | Runtime exports |
|---|---|
@lite-fsm/core | createMachine, createConfig, createReducer, createEffect, createActorMeta, Machine, defineMachine, MachineManager, LiteFsmError |
@lite-fsm/react | FSMContext, FSMContextProvider, FSMHydrationBoundary, useHydrateSnapshot, useManager, useSelector, useTransition, defineMachine |
@lite-fsm/middleware | immerMiddleware, devToolsMiddleware |
@lite-fsm/middleware/immer | immerMiddleware |
@lite-fsm/middleware/devTools | devToolsMiddleware |
@lite-fsm/persist | persistManager, createJsonStorage |
@lite-fsm/persist/react | usePersistStatuses, useIsPersistRestoring |
@lite-fsm/graph | compileLiteFsmGraph, compileLiteFsmGraphProject, selectMachineGraph, analyzeLiteFsmGraph |
@lite-fsm/graph/simulator | createGraphSimulator, createMachineGraphSimulator |
@lite-fsm/graph/view-model | buildGraphVisualizerModel, buildMachineWorkbenchModel, buildMachineFlowModel |
@lite-fsm/cli | команда lite-fsm |
Быстрая карта
| Нужно | Куда идти |
|---|---|
| Описать автомат и запустить manager | Core API |
| Подключить состояние к React | React API |
| Мутировать reducer draft или подключить Redux DevTools | Middleware API |
| Сохранить snapshot в storage | Persist API |
| Построить graph IR или diagnostics | Graph API |
| Создать starter, добавить автомат или экспортировать graph | CLI |
Типы
Основные типы живут рядом с публичными точками входа:
@lite-fsm/core: events, configs, reducers, effects, managers, actors, snapshots, middleware.@lite-fsm/react: props и typed hook aliases.@lite-fsm/persist: storage adapters, controller, status и options.@lite-fsm/graph: IR, diagnostics, project host, simulator и view-model types.
Для сжатого справочника по типам используйте TYPES-CHEATSHEET.md.
Last updated on