@vielzeug/clockwork

Framework-neutral finite state machines with pure transitions and actors

Installation

pnpm add @vielzeug/clockwork
npm install @vielzeug/clockwork
yarn add @vielzeug/clockwork

Quick Start

import { defineMachine } from '@vielzeug/clockwork';

type Event = { type: 'INC' } | { type: 'RESET' };

const counter = defineMachine<{ count: number }, Event>()({
  context: { count: 0 },
  initial: 'idle',
  states: {
    idle: {
      on: {
        INC: { reduce: ({ context }) => ({ count: context.count + 1 }), target: 'idle' },
        RESET: { reduce: () => ({ count: 0 }), target: 'idle' },
      },
    },
  },
});

const actor = counter.createActor();
actor.send({ type: 'INC' });

console.log(actor.snapshot);
// { state: 'idle', context: { count: 1 } }

actor.dispose();

Documentation

• Overview
• Usage Guide
• API Reference
• Examples
• Migration Guide

License

MIT © Helmuth Saatkamp: part of the Vielzeug monorepo.