Skip to content
Check if a certain flag is enabled.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
.travis.yml
LICENSE
README.md
index.js
package.json
test.js

README.md

enabled

Version 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. pattern string, The pattern that the name should satisfy

It will return a boolean indication of a match.

Examples

var flag = 'foo';

enabled('foo', flag); // true;
enabled('bar', flag); // false;

//
// Use * for wild cards.
//
var wildcard = 'foob*';

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

//
// Use - to ignore.
//
var ignore = 'foobar,-shizzle,nizzle';

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

License

MIT

You can’t perform that action at this time.