Skip to main content

Function: getUbiquitousLanguageFromDomain()

getUbiquitousLanguageFromDomain(directory): (id, version?) => Promise<{ markdown: any; }>

Defined in: domains.ts:269

Returns the ubiquitous language dictionary from a domain.

Optionally specify a version to get the ubiquitous language dictionary from a specific version of the domain.

Parameters

ParameterType
directorystring

Returns

Function

Parameters

ParameterType
idstring
version?string

Returns

Promise<{ markdown: any; }>

Example

import utils from '@eventcatalog/utils';

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

const ubiquitousLanguage = await getUbiquitousLanguageFromDomain('Payment');

// Returns the ubiquitous language dictionary from a specific version of the domain
const ubiquitousLanguage = await getUbiquitousLanguageFromDomain('Payment', '0.0.1');