Skip to main content
View as Markdown

Function: getExamplesFromEvent()

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

Defined in: events.ts:351

Get all examples from an event.

Parameters​

ParameterType
directorystring

Returns​

Function

Parameters​

ParameterType
idstring
version?string

Returns​

Promise<object[]>

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