Class ConsulProvider

constructor

• new ConsulProvider(
      options: ConsulProviderOptions,
      http: IDiscoveryHttp,
      runtime: IRuntimeServices,
  ): ConsulProvider

  Parameters

  • options: ConsulProviderOptions

    Agent address, ACL token, datacenter, and wait

  • http: IDiscoveryHttp

    The HTTP seam

  • runtime: IRuntimeServices

    Supplies timers and uuid() for the default instance id

  Returns ConsulProvider

Readonlykind

deregisterSelf

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

  Removes this instance from the agent.

  Parameters

  • registration: SelfRegistration

    The registration to remove

  Returns Promise<void>

headers

• headers(): Record<string, string>

  Headers every request carries; the ACL header is omitted when unset.

  Returns Record<string, string>

healthUrl

• healthUrl(serviceName: string, index?: number): string

  Builds the health-read URL.

  Always sends passing=true: self-registration advertises the instance before its socket is bound, and filtering on passing checks is what makes that window harmless for every consumer.

  Parameters

  • serviceName: string

    Logical service name

  • Optionalindex: number

    Blocking-query index, omitted for a plain read

  Returns string

  The absolute URL

isHealthy

• isHealthy(): Promise<boolean>

  M70c: probes the agent's leader endpoint — GET /v1/status/leader — through the existing IDiscoveryHttp seam. 2xx means the agent is reachable; any other status or a transport failure means it is not. The runtime aborts the request after 2 s so a hung agent cannot hold the connection open.

  Returns Promise<boolean>

mapEntries

• mapEntries(body: unknown, serviceName: string): readonly ServiceInstance[]

  Maps a health response body onto instances.

  Parameters

  • body: unknown

    The parsed JSON array

  • serviceName: string

    Fallback service name when the entry omits one

  Returns readonly ServiceInstance[]

  The mapped instances

registerSelf

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

  Advertises this instance to the agent.

  Parameters

  • registration: SelfRegistration

    What to advertise, with its check already defaulted

  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

selfId

• selfId(registration: SelfRegistration): string

  The instance id used for both register and deregister.

  Generated once per registration object rather than per call, because a fresh uuid on deregistration would target an id that was never registered.

  Parameters

  • registration: SelfRegistration

    The registration

  Returns string

  Its stable instance id

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