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

***

# Function: getExamplesFromEvent()

> **getExamplesFromEvent**(`directory`): (`id`, `version`?) => `Promise`<`object`\[]>

Defined in: events.ts:351

Get all examples from an event.

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

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

`Promise`<`object`\[]>

## Example[​](#example "Direct link to Example")

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

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

const examples = await getExamplesFromEvent('InventoryAdjusted');
const examples = await getExamplesFromEvent('InventoryAdjusted', '0.0.1');
```