@rgrannell/config v8.1.0-alpha.ded934b0

config (v8.1.0-alpha.687ac587)

An alternative to config.js

Table of Contents

• yieldConfig
  • Parameters
• config
  • Parameters

API Documentation

yieldConfig

Merge default & environmental configuration

Parameters

• configPath string the path to environmental configuration
• defaultConf function configuration to merge in too

Returns object

config

Load configuration based on an environmental variable.

Parameters

• environment string an environment variable. Defaults to NODE_ENV
• opts Object

Returns Object environment configuration

Dependencies

• Node.js >= v10.6.0
• NPM >= v10.6.0

License

Copyright (c) 2018 Ryan Grannell

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.