Skip to main content

writeQueryToService

Callable

  • writeQueryToService(directory: string): (query: Query, service: { id: string; version?: string }, options?: { path: string }) => Promise<void>

  • Write a query to a service in EventCatalog.

    You can optionally override the path of the event.

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

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

    // Write an event to a given service in the catalog
    // Event would be written to services/Orders/queries/GetOrder
    await writeQueryToService({
    id: 'GetOrder',
    name: 'Get Order',
    version: '0.0.1',
    summary: 'This is a summary',
    markdown: '# Hello world',
    }, { id: 'Orders' });