xstate-state-tracker v1.0.0

xstate-state-tracker

Small xstate utility to log all state transitions to a specified callback function. Tracks child machines started via invoke too, to any depth.

Usage

Install the package

> npm install xstate-state-tracker --save-dev

Include it in your codebase

import tracker from "xstate-state-tracker";

Pass it an xstate interpreter instance to track

import { Machine, interpret } from "xstate";
import tracker from "xstate-state-tracker";

const statechart = Machine({
    initial : "one",

    states : {
        one : {},
    },
});

const service = interpret(statechart);

// Callback function will be invoked with a machine path as well as the current machine state object
const track = tracker((id, value) => console.log(`${id} :: ${JSON.stringify(value)}`));

// Track the interpreter instance and respond on all changes
track(service);

Context

While developing it's probably better to use @xstate/inspect via statecharts.io than this package as it'll give you a much better overview of what is happening. You can't always attach the visualizer once your code is deployed though and it can be very valuable to know exactly the state your app was in when an error happened.