Skip to main content

rmChannel

Callable

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

  • Delete a channel at it's given path.

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

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

    // removes a channel at the given path (channels dir is appended to the given path)
    // Removes the channel at channels/InventoryChannel
    await rmChannel('/InventoryChannel');