Skip to main content

getDomains

Callable

  • getDomains(directory: string): (options?: { latestOnly?: boolean }) => Promise<Domain[]>

  • Returns all domains from EventCatalog.

    You can optionally specify if you want to get the latest version of the domains.

    @example
    import utils from '@eventcatalog/utils';

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

    // Gets all domains (and versions) from the catalog
    const domains = await getDomains();

    // Gets all domains (only latest version) from the catalog
    const domains = await getDomains({ latestOnly: true });