Node Gilbert Config

npm i -S @gilbertco/config

CI Build Status

Code Style

Basic Example

To load configuration files into process.env for the configuration module to consume a helper function has been provided.

See example use-case.

const config = require('@gilbertco/config');

config.load(process.cwd()+'/config');

let configValue = config.get('SOME_CONFIG_VALUE');

get method

const config = require('@gilbertco/config');

config.get('NODE_ENV'); // returns String
config.get('NODE_ENV', String); // Returns String

config.get('SOME_NUMBER'); // Returns String
config.get('SOME_NUMBER', Number); // Returns Number

config.get('TRUE_OR_FALSE', Boolean); // Returns Boolean

Configuration Directory

• the get method is optional, thus configuration files/directory is optional
• configuration file to load is determined based on NODE_ENV... default NODE_ENV=development
• supported file extensions are (.yaml, .yml, .js, .json)
• default.yml/yaml/js/json file will also be loaded if it exists

Configuration Directory Structure

├── package.json
├── server.js
├── config
|   ├── production.yml
|   ├── test.yml
|   ├── staging.yml
|   └── development.yml

.env Example

A .env file will be automatically be loaded from your process current working directory. (usually where your package.json file is). The contents will be merged into your process.env in your active node process.

.env files are optional

.env file contents example

SOME_ENV_VARIABLE_1=somevalue1
SOME_ENV_VARIABLE_2=somevalue2