Skip to main content

getUbiquitousLanguageFromDomain

Callable

  • getUbiquitousLanguageFromDomain(directory: string): (id: string, version?: string) => Promise<undefined | { markdown: any }>

  • 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.

    @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');