View as Markdown

---

Function: writeVersionedFlow()

writeVersionedFlow(directory): (flow) => Promise<void>

Defined in: flows.ts:161

Write a versioned flow to EventCatalog.

Parameters

Parameter	Type
directory	string

Returns

Function

Parameters

Parameter	Type
flow	Flow

Returns

Promise<void>

Example

import utils from '@eventcatalog/utils';

const { writeVersionedFlow } = utils('/path/to/eventcatalog');

// Flow would be written to flows/PaymentFlow/versioned/0.0.1
await writeVersionedFlow({
  id: 'PaymentFlow',
  name: 'Payment Flow',
  version: '0.0.1',
  markdown: '# Payment Flow',
  steps: [],
});