Class ConsulService

Implements

OnApplicationBootstrap
OnApplicationShutdown

Index

Constructors

Properties

consul datacenter health heartbeatInterval instanceId logger nodeId roundRobinCounters serviceHost serviceName servicePort

Methods

checkHealthDependencies getConsul healthCheck onApplicationBootstrap onApplicationShutdown startHeartbeat

Constructors

constructor

new ConsulService(health: HealthService): ConsulService
Parameters
- health: HealthService
Returns ConsulService
- Defined in src/consul/consul.service.ts:33

Properties

`Private`consul

consul: Consul

`Private`datacenter

datacenter: string

`Private` `Readonly`health

health: HealthService

`Private`heartbeatInterval

heartbeatInterval: Timeout

`Private`instanceId

instanceId: string

`Private` `Readonly`logger

logger: Logger = ...

`Private`nodeId

nodeId: string

`Private`roundRobinCounters

roundRobinCounters: Map<string, number> = ...

`Private`serviceHost

serviceHost: string

`Private`serviceName

serviceName: string

`Private`servicePort

servicePort: number

Methods

checkHealthDependencies

checkHealthDependencies(): Promise<AppHealthType | null>
Returns Promise<AppHealthType | null>
- Defined in src/consul/consul.service.ts:137

getConsul

getConsul(): Consul
Returns Consul
- Defined in src/consul/consul.service.ts:38

healthCheck

healthCheck(): Promise<"error" | "ok" | "partial">
Returns Promise<"error" | "ok" | "partial">
- Defined in src/consul/consul.service.ts:145

onApplicationBootstrap

onApplicationBootstrap(): Promise<void>
Returns Promise<void>
Implementation of OnApplicationBootstrap.onApplicationBootstrap
- Defined in src/consul/consul.service.ts:42

onApplicationShutdown

onApplicationShutdown(): Promise<void>
Returns Promise<void>
Implementation of OnApplicationShutdown.onApplicationShutdown
- Defined in src/consul/consul.service.ts:93

startHeartbeat

startHeartbeat(): void
Returns void
- Defined in src/consul/consul.service.ts:114