Function: removeExampleFromEvent()
removeExampleFromEvent(
directory): (id,fileName,version?) =>Promise<void>
Defined in: events.ts:367
Remove an example file from an event.
Parameters​
| Parameter | Type |
|---|---|
directory | string |
Returns​
Function
Parameters​
| Parameter | Type |
|---|---|
id | string |
fileName | string |
version? | string |
Returns​
Promise<void>
Example​
import utils from '@eventcatalog/utils';
const { removeExampleFromEvent } = utils('/path/to/eventcatalog');
await removeExampleFromEvent('InventoryAdjusted', 'basic.json');
await removeExampleFromEvent('InventoryAdjusted', 'basic.json', '0.0.1');