State diagram

The states an instance moves through, including the soft-deleted one a paranoid model adds.

The code

new StateDiagram({
  title: 'Instance lifecycle',
  states: [
    { name: 'new', initial: true }, { name: 'validated' }, { name: 'persisted' },
    { name: 'soft-deleted' }, { name: 'gone', final: true },
  ],
  transitions: [
    { from: 'new',          to: 'validated',    event: 'validate()' },
    { from: 'validated',    to: 'persisted',    event: 'save()' },
    { from: 'persisted',    to: 'persisted',    event: 'update()' },
    { from: 'persisted',    to: 'soft-deleted', event: 'destroy()' },
    { from: 'soft-deleted', to: 'persisted',    event: 'restore()' },
    { from: 'soft-deleted', to: 'gone',         event: 'destroy({ force: true })' },
  ],
}).generate()

What it produces

Generated by running the snippet above — this is the generator's real output,
rebuilt by scripts/build-diagram-examples.mjs, not a picture of it.

On a model that is not paranoid, destroy() goes straight to the final state — there is no soft-deleted step to come back from.

Saving it

generate() returns the SVG as a string; save(path) writes it straight to
disk.

diagram.save('docs/schema.svg');

Diagram generators — every generator and its options

Models — the definitions these are drawn from

The code#

What it produces#

Saving it#

Related reading#

The code

What it produces

Saving it

Related reading