EnvMask

EnvMask is a utility package that is used to change values of environment varialbles temporarily for testing and restore the original values after thing done.

Installation

Via npm:

$ npm install --save-dev envmask

API

Declaration

var EnvMask = require('envmask');

Constructor

var envmask = new EnvMask(vars);

The constructor (EnvMask) receives a map of key/values that will be used to override the corresponding environment variables in process.env. It backs up the current environment variables before overriding. These backed up values will be recovered when reset() method is invoked.

Methods

envmask.setup(vars)

The argument vars is an object that contains key/values which defined the name of variable and a new value of it, as illustrated by the following example:

{
  APP_INSTANCES: 2,
  NODE_ENV: 'test'
}

This method returns the envmask object itself.

envmask.reset()

Method reset() clears the values of environment variables that assigned by setup() method, and restores the backup values for them. This method also returns the envmask object itself.

envmask.toJSON()

Method toJSON() returns a JSON object that contains the internal state of envmask.

License

MIT