❤
npm
Sign UpSign In

ding-env-config

1.2.0 • Public • Published

env-config

Greenkeeper badge

Travis Coveralls npm npm npm

read configuration form environment by specified format

Getting Start

NPM

install

npm i -S ding-env-config

Usage

// export CONFIG_mongo_db=db1
const envConfig = require('ding-env-config');
const config = envConfig();
// {
//   "mongo": {
//     "db": "db1"
//   }
// }

envConfig([payload]) ⇒ object

once there are somethings like CONFIG_mongo_db in env, the codes below will set config.mongo.db to the env val

Kind: global function Returns: object - parse out config

Param Type Default Description
[payload] object input arguments
[payload.config] object {} default config object
[payload.separator] string "_" symbol between key path and prefix
[payload.prefix] string "CONFIG" prefix to match target environment

Example

// export CONFIG_mongo_db=db1
const config = envConfig();
// {
//   "mongo": {
//     "db": "db1"
//   }
// }
 
// export CONFIG_mongo_port__num=27017
const config = envConfig();
// {
//   "mongo": {
//     "port": 27017
//   }
// }
 
// export CONFIG_mongo_flag=true
const config = envConfig();
// {
//   "mongo": {
//     "flag": "true"
//   }
// }
 
// export CONFIG_mongo_flag__bool=true
const config = envConfig();
// {
//   "mongo": {
//     "flag": true
//   }
// }

Readme

Keywords

Package Sidebar

Install

npm i ding-env-config

Repository

github.com/yidinghan/ding-evn-config

Homepage

github.com/yidinghan/ding-evn-config#readme

Weekly Downloads

2

Version

1.2.0

License

MIT

Last publish

Collaborators

  • playding
Try on RunKit
Report malware