Function: versionDiagram()
versionDiagram(
directory): (id) =>Promise<void>
Defined in: diagrams.ts:185
Version a diagram by its id.
Takes the latest diagram and moves it to a versioned directory. All files with this diagram are also versioned (e.g /diagrams/ArchitectureDiagram/diagram.png)
Parameters
| Parameter | Type |
|---|---|
directory | string |
Returns
Function
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
Promise<void>
Example
import utils from '@eventcatalog/utils';
const { versionDiagram } = utils('/path/to/eventcatalog');
// moves the latest ArchitectureDiagram diagram to a versioned directory
// the version within that diagram is used as the version number.
await versionDiagram('ArchitectureDiagram');