Function: rmEntity()

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

Defined in: entities.ts:133

Delete an entity at its given path.

Parameters

Parameter	Type
directory	string

Returns

Function

Parameters

Parameter	Type
path	string

Returns

Promise<void>

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