View as Markdown

---

Function: getDiagram()

getDiagram(directory): (id, version?) => Promise<Diagram>

Defined in: diagrams.ts:34

Returns a diagram from EventCatalog.

You can optionally specify a version to get a specific version of the diagram

Parameters

Parameter	Type
directory	string

Returns

Function

Parameters

Parameter	Type
id	string
version?	string

Returns

Promise<Diagram>

Example

import utils from '@eventcatalog/utils';

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

// Gets the latest version of the diagram
const diagram = await getDiagram('ArchitectureDiagram');

// Gets a version of the diagram
const diagram = await getDiagram('ArchitectureDiagram', '0.0.1');