Function: rmDiagram()

rmDiagram(directory): (path) => Promise<void>

Defined in: diagrams.ts:140

Delete a diagram at its given path.

Parameters

Parameter	Type
directory	string

Returns

Function

Parameters

Parameter	Type
path	string

Returns

Promise<void>

Example

import utils from '@eventcatalog/utils';

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

// removes a diagram at the given path (diagrams dir is appended to the given path)
// Removes the diagram at diagrams/ArchitectureDiagram
await rmDiagram('/ArchitectureDiagram');