Skip to main content

getEvents

Callable

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

  • Returns all events from EventCatalog.

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

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

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

    // Gets all events (and versions) from the catalog
    const events = await getEvents();

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

    // Get all events with the schema attached
    const events = await getEvents({ attachSchema: true });