@statelyai/inspect
v0.4.0
Published
Inspection utilities for state, actors, workflows, and state machines.
Downloads
131,383
Readme
Stately.ai Inspect
The @statelyai/inspect
package enables developers to visually inspect state transitions and actor communication in any JavaScript/TypeScript app.
Documentation: stately.ai/docs/inspector
Features
- Visualize state machines
- Visualize sequence diagrams
- Works best with XState
- Can be used with any framework or library (or none at all)
Usage
Browser inspector with XState:
import { createBrowserInspector } from '@statelyai/inspect';
import { createActor } from 'xstate';
import { machine } from './someMachine';
const inspector = createBrowserInspector();
const actor = createActor(machine, {
inspect: inspector.inspect,
});
actor.start();
Browser inspector with anything:
import { createBrowserInspector } from '@statelyai/inspect';
const inspector = createBrowserInspector();
// ...
inspector.actor('someActor', {
status: 'active',
context: {
/* any context data */
},
});
inspector.actor('anotherActor');
inspector.event('someActor', 'hello', { source: 'anotherActor' });
inspector.snapshot('anotherActor', {
status: 'active',
context: {
/* any context data */
},
});