npm install swerve
|36||downloads in the last day|
|232||downloads in the last week|
|332||downloads in the last month|
|Version||0.5.0 last updated 3 months ago|
Feature flipping for Node.js
swerve to your
package.json file and
npm install. Or:
npm install swerve --save
If you're using Hem, also make sure you add it to your
slug.json file as a
Require Swerve (globally, in most cases). In CoffeeScript, you'll have something similar to below.
Swerve = require('swerve') # Or, if you have this in some setup file window?.Swerve = require('swerve')
Then, you'll need to configure Swerve with the feature settings you want for each environment by passing in a hash.
Swerve.configure development: notifications: true production: notifications: false
Once you've configured your feature settings, you need to set the current environment:
Now you can toggle different blocks of code throughout your app based on enabled features in one of two ways:
Check the feature as a property on the
if Swerve.notifications console.log('You have notifications!') else console.log('Notifications coming soon.')
feature and pass in the feature name.
if Swerve.feature('notifications') console.log('You have notifications!') else console.log('Notifications coming soon.')
Checking a feature returns the value from the configuration (or URL param, see
section below). While you usually set the value to either
have the flexibility of setting it to whatever you may need (i.e. a hash of
settings for that feature for each environment).
Toggling on the fly
A feature can be enabled by calling
example, which simply sets that feature to
true under the current environment.
You can optionally set the feature to a value:
notification_options = gutter: true disrupt: false Swerve.enable 'notifications', notification_options
Similarly, a feature can be disabled (set to
false) by calling
Toggling with URL parameters
Features can also be enabled or disabled by passing in the feature name as a query string in the URL. These params take precedence over those set in the configuration.
So if we visit
http://www.example.com?notifications=true in our production
environment, then that feature will be considered enabled, regardless of the
setting passed in through the original configuration.
Copyright 2013 Jico Baligod.
Licensed under the MIT License.