Interface DiscoveryProvider

Readonlykind

OptionalderegisterSelf

• deregisterSelf?(registration: SelfRegistration): Promise<void>

  Removes this application instance from the backend.

  Parameters

  • registration: SelfRegistration

    The registration to remove

  Returns Promise<void>

OptionalisHealthy

• isHealthy?(): Promise<boolean>

  M70c: reports whether the discovery backend is reachable right now, for the plugin's health indicator.

  Optional: a provider with no meaningful liveness check omits it, and the indicator then relies on the service's everResolved state. This answers a fact (reachability), not a policy: the indicator owns the up/degraded/ down mapping.

  Returns Promise<boolean>

  true when the backend is reachable

  Since

  0.2.0

OptionalregisterSelf

• registerSelf?(registration: SelfRegistration): Promise<void>

  Registers this application instance with the backend.

  Present only on providers with a registration API (Consul).

  Parameters

  • registration: SelfRegistration

    What to advertise

  Returns Promise<void>

resolve

• resolve(serviceName: string): Promise<readonly ServiceInstance[]>

  Reads the current instance list for a service.

  Parameters

  • serviceName: string

    Logical service name

  Returns Promise<readonly ServiceInstance[]>

  Every instance the backend reports, possibly empty

  Throws

  If the backend cannot be read

watch

• watch(
      serviceName: string,
      listener: (instances: readonly ServiceInstance[]) => void,
  ): Promise<Unsubscribe>

  Subscribes to instance-list changes.

  Push-based where the backend supports it, interval-polled where it does not. The listener always receives the full list.

  Parameters

  • serviceName: string

    Logical service name

  • listener: (instances: readonly ServiceInstance[]) => void

    Called with the full instance list on every change

  Returns Promise<Unsubscribe>

  Unsubscribe function that stops the underlying watch