Skip to main content

addServiceToDomain

Callable

  • addServiceToDomain(directory: string): (id: string, service: { id: string; version: string }, version?: string) => Promise<void>

  • Add a service to a domain by it's id.

    Optionally specify a version to add the service to a specific version of the domain.

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

    // Adds a service to the domain
    const { addServiceToDomain } = utils('/path/to/eventcatalog');

    // Adds a service (Orders Service) to the domain (Orders)
    await addServiceToDomain('Orders', { service: 'Order Service', version: '2.0.0' });
    // Adds a service (Orders Service) to the domain (Orders) with a specific version
    await addServiceToDomain('Orders', { service: 'Order Service', version: '2.0.0' }, '1.0.0');