Class DnsProvider

constructor

• new DnsProvider(
      resolver: IDnsResolver,
      runtime: IRuntimeServices,
      options: DnsProviderOptions,
  ): DnsProvider

  Parameters

  • resolver: IDnsResolver

    The DNS resolver from IRuntimeServices.dns

  • runtime: IRuntimeServices

    Supplies timers for the poll

  • options: DnsProviderOptions

    Mode, template, port, and poll interval

  Returns DnsProvider

Readonlykind

domainFor

• domainFor(serviceName: string): string

  Substitutes the service name into the configured template.

  Parameters

  • serviceName: string

    Logical service name

  Returns string

  The hostname to query

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>

  Polls at watchIntervalMs, firing only when the instance list changed.

  DNS has no push channel. Polling is the honest implementation: a watch() that never fires would be worse than a documented interval.

  Parameters

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

  Returns Promise<Unsubscribe>