Function: rmEvent()

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

Defined in: events.ts:186

Delete an event at it's given path.

Parameters

Parameter	Type
directory	string

Returns

Function

Parameters

Parameter	Type
path	string

Returns

Promise<void>

Example

import utils from '@eventcatalog/utils';

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

// removes an event at the given path (events dir is appended to the given path)
// Removes the event at events/InventoryAdjusted
await rmEvent('/InventoryAdjusted');