1.0.0 • Published 10 years ago

featureset v1.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
10 years ago

featureset

browser support Build Status

A painless feature toggle system in JavaScript. Decouple development and deployment.

Install

$ npm install --save featureset

Usage

var featureset = require('featureset');

// This will set the list of currently active
// features, and add the feature classes to the
// body element. It will take url parameters 
// into account:
var feature = featureset(['feature1', 'feature2']);

// Query for an active feature:
if ( feature.active('search') ) {
  // load the search code
}

features(features):Object

Take an optional list of features, set the feature classes on the body tag, and return the feature toggle object.

  • @param {Array} baseFeatures List of base features.
  • @return {Object} feature object Features passed into featureset()
var feature = featureset(['feature1', 'feature2']);

feature.active('feature1'); // true

.active(feature):Boolean

Check to see if a feature is active.

  • @param {String} feature
  • @return {Boolean}

.activate(features):Object (this)

Activate a list of features.

  • @emits activated
  • @param {Array} features
  • @return {Object} this (for chaining)

activated event.

  • @event activated
  • @type {Array} activated features

.deactivate(features):Object (this)

Deactivate a list of features.

  • @emits deactivated
  • @param {Array} features
  • @return {Object} this (for chaining)

deactivated event.

  • @event deactivated
  • @type {Array} deactivated features

License

MIT