3.0.1 • Published 5 years ago
nest-consul-config v3.0.1
Description
A component of nestcloud. NestCloud is a nest framework micro-service solution.
This is a Nest module to get configurations from consul kv.
Installation
$ npm i --save nest-consul consul nest-consul-config
Quick Start
Import Module
import { Module } from '@nestjs/common';
import { ConsulModule } from 'nest-consul';
import { ConsulConfigModule } from 'nest-consul-config';
const env = process.env.NODE_ENV;
@Module({
imports: [
ConsulModule.register({
host: '127.0.0.1',
port: 8500
}),
ConsulConfigModule.register({key: `config__user-service__${env}`})
],
})
export class ApplicationModule {}
If you use nest-boot module.
import { Module } from '@nestjs/common';
import { ConsulModule } from 'nest-consul';
import { ConsulConfigModule } from 'nest-consul-config';
import { BootModule } from 'nest-boot';
import { NEST_BOOT } from 'nest-common';
@Module({
imports: [
ConsulModule.register({dependencies: [NEST_BOOT]}),
BootModule.register(__dirname, 'bootstrap.yml'),
ConsulConfigModule.register({dependencies: [NEST_BOOT]})
],
})
export class ApplicationModule {}
Nest-boot config file
web:
serviceId:
serviceName: user-service
consul:
host: localhost
port: 8500
config:
# available expressions: {serviceName} {serviceId} {env}
key: config__{serviceName}__{env}
retry: 5
Config Client Injection
In consul kv, the key is "configuser-servicedevelopment".
user:
info:
name: 'test'
import { Injectable } from '@nestjs/common';
import { InjectConfig, ConsulConfig } from 'nest-consul-config';
@Injectable()
export class TestService {
constructor(
@InjectConfig() private readonly config: ConsulConfig
) {}
getUserInfo() {
const userInfo = this.config.get('user.info', {name: 'judi'});
console.log(userInfo);
}
}
Dynamic config update:
import { Injectable } from '@nestjs/common';
import { InjectConfig, ConsulConfig, DynamicConfig, ConfigValue, OnUpdate } from 'nest-consul-config';
@Injectable()
export class TestService extends DynamicConfig implements OnUpdate {
@ConfigValue('user.info', {name: 'judi'})
private readonly userInfo;
constructor(
@InjectConfig() private readonly config: ConsulConfig
) {
super(config);
}
onUpdate() {
// Some service need re-initial after the config updated, you can execute it here.
}
getUserInfo() {
return this.userInfo;
}
}
API
class ConsulConfigModule
static register(options): DynamicModule
Import nest consul config module.
field | type | description |
---|---|---|
options.dependencies | string[] | if you are using nest-boot module, please set NEST_BOOT |
options.key | string | the key of consul kv |
options.retry | number | the max retry count when get configuration fail |
class ConsulConfig
get(path?: string, defaults?: any): any
Get configuration from consul kv.
field | type | description |
---|---|---|
path | string | the path of the configuration |
defaults | any | default value if the specific configuration is not exist |
getKey(): string
Get the current key.
onChange(callback: (configs) => void): void
watch the configurations.
field | type | description |
---|---|---|
callback | (configs) => void | callback function |
async set(path: string, value: any): void
update configuration.
field | type | description |
---|---|---|
path | string | the path of the configuration |
value | any | the configuration |
Stay in touch
- Author - NestCloud
License
NestCloud is MIT licensed.
3.0.1
5 years ago
3.0.0
5 years ago
2.3.2
5 years ago
2.3.1
5 years ago
2.3.0
6 years ago
2.2.0
6 years ago
2.1.0
6 years ago
1.3.0
6 years ago
1.2.0
6 years ago
1.1.0
6 years ago
1.0.0
6 years ago
0.1.3
6 years ago
0.1.2
6 years ago
0.1.1
6 years ago
0.1.0
6 years ago
0.0.9
6 years ago
0.0.8
6 years ago
0.0.7
6 years ago
0.0.6
6 years ago
0.0.5
6 years ago
0.0.4
6 years ago
0.0.3
6 years ago
0.0.2
6 years ago
0.0.1
6 years ago