View as Markdown

---

Function: writeFlowToDomain()

writeFlowToDomain(directory): (flow, domain, options) => Promise<void>

Defined in: flows.ts:187

Write a flow to a domain in EventCatalog.

Parameters

Parameter	Type
directory	string

Returns

Function

Parameters

Parameter	Type
flow	Flow
domain	{ id: string; version: string; }
domain.id	string
domain.version?	string
options	{ format: "md" | "mdx"; override: boolean; path: string; }
options.format?	"md" | "mdx"
options.override?	boolean
options.path?	string

Returns

Promise<void>

Example

import utils from '@eventcatalog/utils';

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

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