Copy as Markdown[View as Markdown](/docs/sdk/functions/rmEntityById.md)

***

# Function: rmEntityById()

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

Defined in: entities.ts:156

Delete an entity by its id.

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

## Parameters[​](#parameters "Direct link to Parameters")

| Parameter   | Type     |
| ----------- | -------- |
| `directory` | `string` |

## Returns[​](#returns "Direct link to Returns")

`Function`

### Parameters[​](#parameters-1 "Direct link to Parameters")

| Parameter       | Type      |
| --------------- | --------- |
| `id`            | `string`  |
| `version`?      | `string`  |
| `persistFiles`? | `boolean` |

### Returns[​](#returns-1 "Direct link to Returns")

`Promise`<`void`>

## Example[​](#example "Direct link to 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');
```