Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

enabled

2.0.0 • Public • Published

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

Install

npm i enabled

DownloadsWeekly Downloads

2,364,753

Version

2.0.0

License

MIT

Unpacked Size

5.89 kB

Total Files

6

Last publish

Collaborators

  • avatar