Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ServiceDiscoveryOptions

Options to configure the service discovery.

Hierarchy

  • ServiceDiscoveryOptions

Index

Constructors

constructor

Methods

getAnnounceAddress

  • getAnnounceAddress(): string
  • Sets the event bus address on which the service arrivals, departures and modifications are announced. This address must be consistent in the whole application.

    Returns string

getBackendConfiguration

  • getBackendConfiguration(): {}
  • Sets the configuration passed to the . Refer to the backend documentation to get more details on the requirements. The default backend does not need any configuration.

    Returns {}

    • [key: string]: any

getName

  • getName(): string
  • Sets the service discovery name used in the service usage events. If not set, the node id is used.

    Returns string

getUsageAddress

  • getUsageAddress(): string
  • Sets the usage address: the event bus address on which are sent the service usage events (bind / release).

    Returns string

setAnnounceAddress

  • Sets the event bus address on which the service arrivals, departures and modifications are announced. This address must be consistent in the whole application.

    Parameters

    • announceAddress: string

    Returns ServiceDiscoveryOptions

setBackendConfiguration

  • Sets the configuration passed to the . Refer to the backend documentation to get more details on the requirements. The default backend does not need any configuration.

    Parameters

    • backendConfiguration: {}
      • [key: string]: any

    Returns ServiceDiscoveryOptions

setName

  • Sets the service discovery name used in the service usage events. If not set, the node id is used.

    Parameters

    • name: string

    Returns ServiceDiscoveryOptions

setUsageAddress

  • Sets the usage address: the event bus address on which are sent the service usage events (bind / release).

    Parameters

    • usageAddress: string

    Returns ServiceDiscoveryOptions

toJson

  • toJson(): {}
  • Returns {}

    • [key: string]: any

Generated using TypeDoc