Skip to main content

rmEvent

Callable

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

  • Delete an event at it's given path.

    @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');