Class ConsulService

Hierarchy

ConsulService

Implements

IConsulService
OnModuleDestroy

Index

Constructors

Properties

config discoveryService log

Methods

getConnectionParams getKv onModuleDestroy register setKv

Constructors

constructor

new ConsulService(log, config, discoveryService): ConsulService
Parameters
- log: ILogger
- config: IConfig<any>
- discoveryService: ConsulDiscoveryService
Returns ConsulService
- Defined in consul/src/main/ts/consul.service.ts:36

Properties

`Private` config

config: IConfig<any>

`Private` discoveryService

discoveryService: ConsulDiscoveryService

`Private` log

log: ILogger

Methods

getConnectionParams

getConnectionParams(serviceName): Promise<undefined | {
host: string;
port: number;
}>
Get connection params by service name.
Parameters
- serviceName: string
Returns Promise<undefined | {
host: string;
port: number;
}>
Host and port to connection
Implementation of IConsulService.getConnectionParams
- Defined in consul/src/main/ts/consul.service.ts:81

getKv

getKv(key): Promise<INormalizedConsulKvValue>
Get value by key from storage
Parameters
- key: string
Returns Promise<INormalizedConsulKvValue>
Value by key
Implementation of IConsulService.getKv
- Defined in consul/src/main/ts/consul.service.ts:90

onModuleDestroy

onModuleDestroy(): Promise<void>
Returns Promise<void>
Implementation of OnModuleDestroy.onModuleDestroy
- Defined in consul/src/main/ts/consul.service.ts:43

register

register(): Promise<void>
Register service in consul.

Returns Promise<void>
Implementation of IConsulService.register
- Defined in consul/src/main/ts/consul.service.ts:47

setKv

setKv(data): Promise<boolean>
Set key-value in storage
Parameters
- data: IConsulKvSetOptions
Returns Promise<boolean>
Implementation of IConsulService.setKv
- Defined in consul/src/main/ts/consul.service.ts:94