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

***

# Function: rmEntity()

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

Defined in: entities.ts:133

Delete an entity at its given path.

## 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     |
| --------- | -------- |
| `path`    | `string` |

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

`Promise`<`void`>

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