Function: versionDomain()

versionDomain(directory): (id) => Promise<void>

Defined in: domains.ts:161

Version a domain by it's id.

Takes the latest domain and moves it to a versioned directory. All files with this domain are also versioned. (e.g /domains/Payment/openapi.yml)

Parameters

Parameter	Type
directory	string

Returns

Function

Parameters

Parameter	Type
id	string

Returns

Promise<void>

Example

import utils from '@eventcatalog/utils';

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

// moves the latest Payment domain to a versioned directory
// the version within that domain is used as the version number.
await versionDomain('Payment');