# nest-consul-config

> A Nest framework (node.js) module for getting configurations from consul kv

Latest version **3.0.1** (published 2019-02-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install nest-consul-config
pnpm add nest-consul-config
yarn add nest-consul-config
bun add nest-consul-config
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.1 |
| Published | 2019-02-28 |
| First published | 2018-05-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 66.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Miaowing |
| Maintainers | zfeng |

## Links

- npm: https://www.npmjs.com/package/nest-consul-config
- Repository: https://github.com/nest-cloud/nest-consul-config
- Homepage: https://github.com/nest-cloud/nest-consul-config#readme
- Issues: https://github.com/nest-cloud/nest-consul-config/issues
- npm.io page: https://npm.io/package/nest-consul-config

## Dependencies (6)

- [consul](https://npm.io/package/consul.md) ^0.34.1
- [yamljs](https://npm.io/package/yamljs.md) ^0.3.0
- [nest-boot](https://npm.io/package/nest-boot.md) ^2.0.0
- [nest-common](https://npm.io/package/nest-common.md) 0.0.1
- [@types/lodash](https://npm.io/package/@types/lodash.md) ^4.14.108
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.1.12

## Recent versions

- 3.0.1 (latest) — 2019-02-28
- 3.0.0 — 2019-02-14
- 2.3.2 — 2018-11-21
- 2.3.1 — 2018-11-21
- 2.3.0 — 2018-09-26
- 2.2.0 — 2018-09-26
- 2.1.0 — 2018-09-12
- 1.3.0 — 2018-09-10
- 1.2.0 — 2018-09-10
- 1.1.0 — 2018-09-06
- 1.0.0 — 2018-06-12
- 0.1.3 — 2018-06-05
- 0.1.2 — 2018-05-30
- 0.1.1 — 2018-05-30
- 0.1.0 — 2018-05-30
- … 9 more at https://npm.io/package/nest-consul-config/versions

## README

<p align="center">
  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo_text.svg" width="320" alt="Nest Logo" /></a>
</p>

## Description

A component of [nestcloud](http://github.com/nest-cloud/nestcloud). NestCloud is a nest framework micro-service solution.
  
[中文文档](https://nestcloud.org/solutions/pei-zhi-zhong-xin)

This is a [Nest](https://github.com/nestjs/nest) module to get configurations from consul kv.

## Installation

```bash
$ npm i --save nest-consul consul nest-consul-config
```

## Quick Start

#### Import Module

```typescript
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](https://github.com/miaowing/nest-boot) module.

```typescript
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

```yaml
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 "config__user-service__development".

```yaml
user:
  info:
    name: 'test'
```

```typescript
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:

```typescript
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\) =&gt; void\): void

watch the configurations.

| field | type | description |
| :--- | :--- | :--- |
| callback | \(configs\) =&gt; 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](https://github.com/nest-cloud)

## License

  NestCloud is [MIT licensed](LICENSE).

---
_Source: https://npm.io/package/nest-consul-config · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._