View as Markdown

---

Function: addFileToFlow()

addFileToFlow(directory): (id, file, version?) => Promise<void>

Defined in: flows.ts:329

Adds a file to the given flow.

Parameters

Parameter	Type
directory	string

Returns

Function

Parameters

Parameter	Type
id	string
file	{ content: string; fileName: string; }
file.content	string
file.fileName?	string
version?	string

Returns

Promise<void>

Example

import utils from '@eventcatalog/utils';

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

// adds a file to the latest PaymentFlow flow
await addFileToFlow('PaymentFlow', { content: 'Hello world', fileName: 'notes.md' });

// adds a file to a specific version of the PaymentFlow flow
await addFileToFlow('PaymentFlow', { content: 'Hello world', fileName: 'notes.md' }, '0.0.1');