Skip to main content

rmEntity

Callable

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

  • Delete an entity at its given path.

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

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

    // removes an entity at the given path (entities dir is appended to the given path)
    // Removes the entity at entities/User
    await rmEntity('/User');