View as Markdown

---

Function: addFileToDiagram()

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

Defined in: diagrams.ts:226

Adds a file to the given diagram.

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 { addFileToDiagram } = utils('/path/to/eventcatalog');

// adds a file to the diagram
await addFileToDiagram('ArchitectureDiagram', { content: '...', fileName: 'diagram.png' });

// adds a file to a specific version of the diagram
await addFileToDiagram('ArchitectureDiagram', { content: '...', fileName: 'diagram.png' }, '0.0.1');