interface ConsulDiscoveryOptions
extends CommonDiscoveryOptions
Since 0.2.0

The 'consul' arm.

Properties

readonly
provider: "consul"

Discriminant.

readonly
address: string

Base URL of the Consul agent, e.g. http://127.0.0.1:8500.

readonly
optional
token: string

ACL token, sent as X-Consul-Token.

readonly
optional
datacenter: string

Datacenter, sent as ?dc=.

readonly
optional
waitSeconds: number

Blocking-query wait, in seconds. Default 30, clamped to Consul's documented maximum of 600.

readonly
optional
secure: boolean

Whether resolved instances speak TLS — Consul carries no scheme.

readonly
optional
http: IDiscoveryHttp

Overrides the default fetch-backed HTTP seam.

Usage

import { type ConsulDiscoveryOptions } from "service-discovery-plugin/src/index.ts";