Skip to main content

getQueries

Callable

  • getQueries(directory: string): (options?: { attachSchema?: boolean; latestOnly?: boolean }) => Promise<Query[]>

  • Returns all queries from EventCatalog.

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

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

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

    // Gets all queries (and versions) from the catalog
    const queries = await getQueries();

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

    // Gets all queries with the schema attached
    const queries = await getQueries({ attachSchema: true });