Shaman-config NPM

shaman-config

v1.1.4

版本记录

v1.1.0 : 新增了日志处理，在根目录logs下，以天为单位，7天有效期

shaman-config 是一个用于监听配置项/文件变化，然后触发自定义回调函数的模块，它可配合线上配置管理后台使用，目前支持监听配置文件的增、删、改操作，还能获取部署项目某个配置或配置文件的内容。

您需要完整模块文件的映射? 试试 shaman-config。

注意

本地调试配置文件根目录需命名为：config ，且目录放在项目根路径下，与 node_modules 平级。

安装

这是一个 Node.js 模块，可以在 npm 注册表里查询得到. 安装使用 NPM 安装命令： npm install command:

$ npm install shaman-config

API

const { init, addListener, getData } = require('shaman-config')

init( k8sApp, staticName, useConfigPlatform )

初始化应用信息，开启监听器。如果是本地环境则使用轮询获取远端配置模拟文件监听，轮询间隔是10秒。

k8sApp 部署应用名必传，值可取 null、undefined、''
staticName 静态配置文件名必传，默认值：'static.yaml'，值可取 null、undefined、''
useConfigPlatform 是否开启轮询可选，默认值为 true，是否需要使用配置管理后台，决定是否开启轮询从远端获取配置信息，默认开启

若 k8sApp 为空，会从静态文件里取 k8s-app 属性。

addListener ( configName, callBack )

增加被监听项，及其回调方法。

configName 配置文件名必传
callBack 回调方法必传
返回值: true or false

getData ( configName )

获取配置项 / 配置文件的内容。

configName 配置文件名必传
返回值格式 { configName: content, ...}

单元测试

$ npm install
$ npm run test

用例

const { init, addListener, getData } = require('shaman-config')
const k8sApp = "audio-waveform-server";
/**  
 * init( k8sApp, staticName, useConfigPlatform )
 * staticName 为空，取默认静态配置static.yaml
 * useConfigPlatform 不传默认为 true
 */
init(k8sApp, ''); 

addListener('shaman.c.test', data => {
  console.log('我是普通配置shaman.c.test的回调: ',data)
});
addListener('shaman.s.test', data => {
  console.log('我是加密配置shaman.s.test的回调: ',data)
});
const sTestData = getData('shaman.s.test');