Flow diagram

A read, from the finder you call to the instances you get back.

The code

new FlowDiagram({
  title: 'findAll()',
  direction: 'horizontal',
  nodes: [
    { id: 'call',  label: 'findAll(options)' },
    { id: 'assoc', label: 'resolve includes' },
    { id: 'build', label: 'dialect builds SQL' },
    { id: 'run',   label: 'driver executes' },
    { id: 'cast',  label: 'coerce values' },
    { id: 'out',   label: 'model instances' },
  ],
  edges: [
    { from: 'call', to: 'assoc' }, { from: 'assoc', to: 'build' },
    { from: 'build', to: 'run' },  { from: 'run',   to: 'cast'  },
    { from: 'cast', to: 'out' },
  ],
}).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.

Only the "dialect builds SQL" step differs per engine — everything either side of it is shared.

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