Skip to main content

getQuery

Callable

  • getQuery(directory: string): (id: string, version?: string, options?: { attachSchema?: boolean }) => Promise<Query>

  • Returns a query from EventCatalog.

    You can optionally specify a version to get a specific version of the query

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

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

    // Gets the latest version of the event
    const event = await getQuery('GetOrder');

    // Gets a version of the event
    const event = await getQuery('GetOrder', '0.0.1');

    // Gets the query with the schema attached
    const event = await getQuery('GetOrder', '0.0.1', { attachSchema: true });