root 3bf41bf355 update 1 year ago
..
.npmignore 3bf41bf355 update 1 year ago
.travis.yml 3bf41bf355 update 1 year ago
LICENSE.md 3bf41bf355 update 1 year ago
README.md 3bf41bf355 update 1 year ago
index.js 3bf41bf355 update 1 year ago
package.json 3bf41bf355 update 1 year ago
test.js 3bf41bf355 update 1 year ago

README.md

enabled

From bigpipe.ioVersion npmBuild StatusDependenciesCoverage Status

Enabled is a small utility that can check if certain namespace are enabled by environment variables which are automatically transformed to regular expressions for matching.

Installation

The module is release in the public npm registry and can be used in browsers and servers as it uses plain ol ES3 to make the magic work.

npm install --save enabled

Usage

First of all make sure you've required the module using:

'use strict';

var enabled = require('enabled');

The returned enabled function accepts 2 arguments.

  1. name string, The namespace that should match.
  2. variables array, optional, Names of the env variable that it should use for matching. If no argument is supplied it will default to diagnostics and debug.

Examples

process.env.DEBUG = 'foo';
enabled('foo') // true;
enabled('bar') // false;

// can use wildcards
process.env.DEBUG = 'foob*';

enabled('foobar') // true;
enabled('barfoo') // false;

process.env.DEBUG = 'foobar,-shizzle,nizzle';

enabled('foobar') // true;
enabled('shizzle-my-nizzle') // false;
enabled('nizzle') // true;

License

MIT