Function: rmEntityById()

rmEntityById(directory): (id, version?, persistFiles?) => Promise<void>

Defined in: entities.ts:155

Delete an entity by its id.

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

Parameters

Parameter	Type
directory	string

Returns

Function

Parameters

Parameter	Type
id	string
version?	string
persistFiles?	boolean

Returns

Promise<void>

Example

import utils from '@eventcatalog/utils';

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

// deletes the latest User entity
await rmEntityById('User');

// deletes a specific version of the User entity
await rmEntityById('User', '0.0.1');