confucio

1.1.1 • Public • Published

confucio

NPM version NPM dependencies NPM devdependencies node license Commitizen friendly

Node.js configuration module. Uses nconf under the hood.

Installation

Download node at nodejs.org and install it, if you haven't already.

npm i --save confucio

Features

Load config from files in this order:

  • /etc/{{applicationName}}.conf
  • {{HOME}}/.config/{{applicationName}}.conf
  • Environment
  • Argv

Usage

var applicationName = 'my-application-name';
var defaultEnvironment = 'production';
 
var config = require('confucio')(applicationName, defaultEnvironment);

API Reference

(moduleName, [defaultEnvironment]) ⇒ nconf instance

Loads config with nconf and returns the nconf object itself

Param Type Description
moduleName string Your application/module name
defaultEnvironment string Optional. Default environment, in case that APPLICATION_ENV is not found. 'development' by default

Tests

npm install
npm test

License

EUPL v1.1

Copyright 2015 Irontec SL

Licensed under the EUPL, Version 1.1 or - as soon they will be approved by the European
Commission - subsequent versions of the EUPL (the "Licence"); You may not use this work
except in compliance with the Licence.

You may obtain a copy of the Licence at:
http://ec.europa.eu/idabc/eupl.html

Unless required by applicable law or agreed to in writing, software distributed under
the Licence is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF
ANY KIND, either express or implied. See the Licence for the specific language
governing permissions and limitations under the Licence.

Dependencies (2)

Dev Dependencies (2)

Package Sidebar

Install

npm i confucio

Weekly Downloads

0

Version

1.1.1

License

EUPL-1.1

Last publish

Collaborators

  • irontec-user