@nestcloud2/config NPM

NestCloud - Config

Description

A NestCloud component for getting and watching configurations from consul kv or kubernetes configmaps.

Installation

$ npm i --save @nestcloud2/config

Quick Start

Import Module

import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestcloud2/config';
import { BOOT, CONSUL, ETCD, KUBERNETES } from '@nestcloud2/common';

@Module({
    imports: [
        // Consul
        ConfigModule.forRootAsync({ inject: [BOOT, CONSUL] }),
        // Etcd
        ConfigModule.forRootAsync({ inject: [BOOT, ETCD] }),
        // Kubernetes
        ConfigModule.forRootAsync({ inject: [BOOT, KUBERNETES] }),
    ],
})
export class AppModule {}

Configurations

config.key is available for consul backend and etcd backend. config.key, config.namespace, config.path are only available for kubernetes configMap.

config:
    name: nestcloud-conf
    namespace: default
    path: config.yaml

Configurations In Consul KV Or Etcd

user:
    info:
        name: 'test'

Configurations In Kubernetes ConfigMap

apiVersion: v1
data:
    config.yaml: |-
        user:
          info:
            name: 'test'

kind: ConfigMap
metadata:
    name: nestcloud-conf
    namespace: default

Inject Config Client

import { Injectable, OnModuleInit } from '@nestjs/common';
import { InjectConfig, Config } from '@nestcloud2/config';

@Injectable()
export class ConfigService implements OnModuleInit {
    constructor(@InjectConfig() private readonly config: Config) {}

    onModuleInit() {
        const userInfo = this.config.get('user.info', { name: 'judi' });
        console.log(userInfo);
    }
}

Inject value

import { Injectable } from '@nestjs/common';
import { ConfigValue } from '@nestcloud2/config';

@Injectable()
export class ConfigService {
    @ConfigValue('user.info', { name: 'judi' })
    private readonly userInfo;
}

API

class ConfigModule

static forRootAsync(options): DynamicModule

field	type	description
options.inject	string[]	BOOT, CONSUL, KUBERNETES
options.name	string	key of the consul kv or name of the kubernetes configMap
options.namespace	string	the kubernetes namespace
options.path	string	the path of the kubernetes configMap