Skip to main content

Function: removeExampleFromQuery()

removeExampleFromQuery(directory): (id, fileName, version?) => Promise<void>

Defined in: queries.ts:368

Remove an example file from a query.

Parameters​

ParameterType
directorystring

Returns​

Function

Parameters​

ParameterType
idstring
fileNamestring
version?string

Returns​

Promise<void>

Example​

import utils from '@eventcatalog/utils';

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

await removeExampleFromQuery('GetOrder', 'basic.json');
await removeExampleFromQuery('GetOrder', 'basic.json', '0.0.1');