enabled
v2.0.0
Published
Check if a certain debug flag is enabled.
Downloads
38,952,879
Maintainers
Readme
enabled
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.
name
string, The namespace that should match.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;