Function: rmChangelog()

rmChangelog(catalogDir): (id, options) => Promise<void>

Defined in: changelogs.ts:191

Removes the changelog for a resource in EventCatalog.

Parameters

Parameter	Type
catalogDir	string

Returns

Function

Parameters

Parameter	Type
id	string
options	{ version: string; }
options.version?	string

Returns

Promise<void>

Example

import utils from '@eventcatalog/utils';

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

// Remove the changelog for a resource
await rmChangelog('OrderCreated');

// Remove the changelog for a specific version
await rmChangelog('OrderCreated', { version: '1.0.0' });