Function: getChangelog()

getChangelog(catalogDir): (id, options) => Promise<Changelog>

Defined in: changelogs.ts:153

Returns 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<Changelog>

Example

import utils from '@eventcatalog/utils';

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

// Get the changelog for a resource
const changelog = await getChangelog('OrderCreated');

// Get the changelog for a specific version
const changelog = await getChangelog('OrderCreated', { version: '1.0.0' });