Skip to main content

writeCommandToService

Callable

  • writeCommandToService(directory: string): (command: Command, service: { id: string; version?: string }, options?: { path: string }) => Promise<void>

  • Write an command to a service in EventCatalog.

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

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

    // Write an event to a given service in the catalog
    // Event would be written to services/Inventory/commands/UpdateInventory
    await writeCommandToService({
       id: 'UpdateInventory',
       name: 'Update Inventory',
       version: '0.0.1',
       summary: 'This is a summary',
       markdown: '# Hello world',
    }, { id: 'Inventory' });