@playster/config-plugin

Config Plugin ============= #### This plugin lets you load yml files as configs in your projects

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@playster/config-plugin
Minified + gzip package size for @playster/config-plugin in KB

Readme

Config Plugin

This plugin lets you load yml files as configs in your projects

Installation

$ npm i -S @playster/config-plugin

or with yarn

$ yarn add @playster/config-plugin

Usage

// Commonjs
const ConfigPlugin = require('@playster/config-plugin').default

// ES6 module way
import ConfigPlugin from '@playster/config-plugin'

const conf = new ConfigPlugin([
  'path/to/your/config.yml'
])

The constructor expect an array of path [string] or object containing:

  • path: [string] The path of the file relative to project root
  • throw: [boolean] If it should throw an exception in case the file is not found

The files will be loaded in the order you set, so the second file will always overwrite the first, and so on...

Note: Don't forget to use .default if using es5 modules

API

get method

The get method is a proxy to the lodash get function without specifying the object

example:

conf.get('var1.nestedvar', defaultValue)

wholeConfig (getter)

This getter will return the whole config object

example:

const configObject = conf.wholeConfig

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.