Config ⚙️

Cache and handle config files for Node.js

The intention behind this repository is to always maintain a Config package that will handle all the config files inside config folder.

Installation

To use the high potential from this package you need to install first this other packages from SecJS, it keeps as dev dependency because one day @secjs/core will install everything once.

npm install @secjs/env @secjs/utils @secjs/exceptions

Then you can install the package using:

npm install @secjs/config

Usage

Files template

First you need to create the configuration files in the config folder on project root path. Is extremely important to use export default in these configurations. You can check more templates here.

// ./config/app.ts
export default {
  hello: 'world'
}

Config

You can use Config class as a global importing just one time the global file

import '@secjs/config/src/utils/global'

;(async () => {
  await new Config().load()
  
  Config.get('app.hello')
})()

Use Config class to load and get values from config files and environment variables.

import { Config } from '@secjs/config'

;(async () => {
  process.env.DB_HOST = '127.0.0.1'
  // First of all you need the load all the configurations
  await new Config().load()
})()

// Now Config is ready to use
console.log(Config.get('app')) // { hello: 'world' }
console.log(Config.get('app.hello')) // world

// You can use Config to get environment variables too but we recommend using Env function from @secjs/env
console.log(Config.get('DB_HOST')) // 127.0.0.1

// You can use a defaultValue, if config does not exist, defaultValue will be returned
console.log(Config.get('app.dbPort', 3030)) // 3030

Using Config.get inside configuration files

You can use Config.get appointing to other configurations files inside configuration files, but it can't be circular, if circular is found, an exception will be thrown on load.

🛑 BAD! 🛑

// ./config/app.ts
export default {
  hello: Config.get('database.hello')
}

// ./config/database.ts
export default {
  hello: Config.get('app.hello')
}

🟢 GOOD! 🟢

// ./config/app.ts
export default {
  hello: Config.get('database.hello')
}

// ./config/database.ts
export default {
  hello: Config.get('cache.hello'),
  environmentVariable: Config.get('DB_HOST')
}

// ./config/cache.ts
export default {
  hello: 'hello',
}

What happened here ?

Config understands that app.ts needs database.ts to work, but database.ts needs cache.ts to work too. So Config will start loading cache.ts configuration file first, because this file is at the top of the dependency chain.

License

Made with 🖤 by jlenon7 :wave: