https://github.com/zswang/rtconfig

A real time updated configuration.
https://github.com/zswang/rtconfig

configuration

Last synced: about 1 month ago
JSON representation

A real time updated configuration.

• Host: GitHub
• URL: https://github.com/zswang/rtconfig
• Owner: zswang
• Created: 2016-07-22T03:12:38.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-02-09T14:39:45.000Z (almost 7 years ago)
• Last Synced: 2024-10-04T12:18:09.970Z (about 1 month ago)
• Topics: configuration
• Language: JavaScript
• Size: 19.5 KB
• Stars: 9
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Real Time Config 实时配置

-------

# [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][coverage-image]][coverage-url]

## 背景

服务变更配置时通常需要重启进程，但这样会导致服务中断，一些事务性的处理会受到影响，严重时会导致数据异常。为此写了一个通过侦测文件修改时间刷新配置的小工具。

### 需求场景

* 标识服务器升级中，停止写入操作；

* 按运营需要调整数值；

* 动态切换连接服务器。

## 使用

### 安装

```bash

$ npm install rtconfig --save

```

### 示例

```js

var RealtimeConfig = require('rtconfig');

var config = new RealtimeConfig('config/config.js');

app.get('commit', function (req, res) {

	if (config.updating) {

		res.json({

			error: '正在升级，请稍后重试。'

		});

		return;

	}

	// ...

});

```

## 小成本修改

### 修改前

```js

const config = require('./config.json');

```

### 修改后

```js

const config = new (require('rtconfig'))('./config.json');

```

> 已投入实战，请放心使用

## License

MIT © [zswang](http://weibo.com/zswang)

[npm-url]: https://npmjs.org/package/rtconfig

[npm-image]: https://badge.fury.io/js/rtconfig.svg

[travis-url]: https://travis-ci.org/zswang/rtconfig

[travis-image]: https://travis-ci.org/zswang/rtconfig.svg?branch=master

[coverage-url]: https://coveralls.io/github/zswang/rtconfig?branch=master

[coverage-image]: https://coveralls.io/repos/zswang/rtconfig/badge.svg?branch=master&service=github