Skip to main content
View as Markdown

Function: getExamplesFromQuery()

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

Defined in: queries.ts:352

Get all examples from a query.

Parameters​

ParameterType
directorystring

Returns​

Function

Parameters​

ParameterType
idstring
version?string

Returns​

Promise<object[]>

Example​

import utils from '@eventcatalog/utils';

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

const examples = await getExamplesFromQuery('GetOrder');
const examples = await getExamplesFromQuery('GetOrder', '0.0.1');