1.9.0 • Published 3 years ago

sigmundd-config v1.9.0

Weekly downloads
-
License
ISC
Repository
-
Last release
3 years ago

config

Simple Config with ENV Support.

Installation

  • npm install --save sigmundd-config

Usage

const Config = require('sigmundd-config')
let config = new Config([basePath])

Then config is your config object. (Use it like config.setting)

It reads from the following sources, performing a deep merge:
(The Top Value overwrites the lower ones)

  • ENV
  • config.json
  • config.defaults.json

Enviroment Variables can target deep nested settings:
The Setting setting.deep.key can be reached with SETTING_DEEP_KEY

You may use the function reload() to reload the config from all sources.
`config.reload()

This makes reload a reserved keyword

If you give a basePath, the config-Files are used from there.
Else the main dir of the application will be used.

Examples

Only config.defaults.json

node examples/only-defaults/index.js

Only config.json

(Kind of legacy use)

node examples/only-local/index.js

defaults and config.json

node examples/defaults-overwrite/index.js

enviroment variables

(Enviroment set by command to not pollute your machine)

SETTING=overwritten-by-env node examples/env/index.js