Interface Service



isStopped: boolean

True if the service is stopped

stopped: Promise<Error>

A promise that gets resolved to null or Error once the service ends. If an error, then service exited because of an error.


  • A group is a subject prefix from which endpoints can be added. Can be empty to allow for prefixes or tokens that are set at runtime without requiring editing of the service. Note that an optional queue can be specified, all endpoints added to the group, will use the specified queue unless the endpoint overrides it. see EndpointOptions and ServiceConfig.


    • Optional subject: string
    • Optional queue: string

    Returns ServiceGroup

  • Returns a service info for the service

    Returns ServiceInfo

  • Resets all the stats

    Returns void

  • Returns the stats for the service.

    Returns Promise<ServiceStats>

  • Stop the service returning a promise once the service completes. If the service was stopped due to an error, that promise resolves to the specified error


    • Optional err: Error

    Returns Promise<Error>

Generated using TypeDoc