Skip to main content

getCustomDocs

Callable

  • getCustomDocs(directory: string): (options?: { path?: string }) => Promise<CustomDoc[]>

  • Returns all custom docs for the project.

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

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

    // Gets all custom docs from the catalog
    const customDocs = await getCustomDocs();

    // Gets all custom docs from the given path
    const customDocs = await getCustomDocs({ path: '/guides' });