View as Markdown

---

Function: addExampleToQuery()

addExampleToQuery(directory): (id, example, version?) => Promise<void>

Defined in: queries.ts:336

Add an example file to a query.

Parameters

Parameter	Type
directory	string

Returns

Function

Parameters

Parameter	Type
id	string
example	{ content: string; fileName: string; }
example.content	string
example.fileName?	string
version?	string

Returns

Promise<void>

Example

import utils from '@eventcatalog/utils';

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

await addExampleToQuery('GetOrder', { content: '{"id": "123"}', fileName: 'basic.json' });
await addExampleToQuery('GetOrder', { content: '{"id": "123"}', fileName: 'basic.json' }, '0.0.1');