dotenv-assert

dotenv-assert

Requires specified environment settings to exist in node applications.

Version 2.0.0

• This module version no longer accepts an Array of settings to assert. Instead, an Options Object: { filePath: 'somefile.ext' } or empty arguments are required.

Prerequisites

• dotenv is not required, but recommended
  • npmjs.org/package/dotenv
  • github/motdolta/dotenv

How does it work

An exception is thrown if any of these cases are true:

• An assert.env file is not found
• The keys listed in the assert.env file are not set on process.env

Installation

$ npm install --save dotenv-assert

Usage

/**
*  load an assert.env file from CWD or
*  from the nearest parent directory where assert.env is found
*/
require('dotenv-assert')();

/**
*  or, specify a custom file location
*/
require('dotenv-assert')({
  filePath: '../configs/assert.config'
});

/**
*  or, specify a custom file name, that will be loaded from
*  CWD or the nearest parent directory where it is found.
*/
require('dotenv-assert')({
  filePath: 'env.config'
});

Simple HTTP Server Example

This example uses dotenv for applying settings, hence the ~/app/.env file listed below:

• ~/app/.env

  IP=127.0.0.1
  PORT=1337
  

• ~/app/assert.env

  IP
  PORT
  

• ~/app/index.js

  var dotenv = require('dotenv');
  dotenv.load();
  
  require('dotenv-assert')();
  
  var http = require('http');
  
  http.createServer(function (request, response) {
    response.writeHead(200, {'Content-Type': 'text/plain'});
    response.end('Hello World\n');
  }).listen(process.env.PORT, process.env.IP);
  
  console.log('Server running at http://' + process.env.IP + ':' + process.env.PORT + '/');
  

• Start the server and see that all is well

  $ node index.js
  Server running at http://127.0.0.1:1337/
  

LICENSE

ISC License (ISC)

Copyright © 2014, Buster Collings

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.