Skip to main content

rmEventById

Callable

  • rmEventById(directory: string): (id: string, version?: string, persistFiles?: boolean) => Promise<void>

  • Delete an event by it's id.

    Optionally specify a version to delete a specific version of the event.

    @example
    import utils from '@eventcatalog/utils';

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

    // deletes the latest InventoryAdjusted event
    await rmEventById('InventoryAdjusted');

    // deletes a specific version of the InventoryAdjusted event
    await rmEventById('InventoryAdjusted', '0.0.1');