npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

flipit

v2.0.3

Published

Feature flagging for NodeJS

Downloads

34

Readme

Build Status Coverage Status wercker status

flipit

A module that allows you to use feature flags (also known as feature flipping) in Node.js.

You can enable/disable features programmatically or via an external configuration file. Any changes to the configuration file will update the module without requiring a restart.

Configuration File

Optionally, the flipit module can load a JSON file that contains the feature flags/switches, as well as their initial state.

{
    "testFeature": true,
    "anotherFeatureForTesting": true,
    "thisShouldBeUnavailable": false
}

Example Usage

var flipit = require('flipit'),
	result;

flipit.load('testConfigurationFile.json');

result = flipit.isEnabled('testFeature');
console.log(result);    // true

result = flipit.isEnabled('thisShouldBeUnavailable');
console.log(result);    // false

flipit.disable('testFeature');
result = flipit.isEnabled('testFeature');
console.log(result);    // false

flipit.enable('thisShouldBeUnavailable');
result = flipit.isEnabled('thisShouldBeUnavailable');
console.log(result);    // true

API

load('filepathToJsonFile', [callback])

Loads a JSON file containing an object of key-value pairs.

  • 'filepathToJsonFile': The absolute path to the JSON configuration file.
  • callback: Optional. The flipit module will detect any updates made to the given JSON file. After the state of the feature flags/switches has been updated, the callback will be triggered.

Returns a fs.FSWatcher object. For reference: Node.JS API document.

isEnabled('featureName')

Checks if a given feature 'featureName' is enabled.

  • 'featureName': The name of the feature flag/switch. If loaded from a JSON configuration file, this will be the name of the key.

Returns true or false, whether the feature flag/switch is (respectively) enabled or disabled.

disable('featureName')

Disables a given feature 'featureName'. Calling flipit.disable() with a feature that is already disabled is a no-op, not an error.

  • 'featureName': The name of the feature flag/switch. If loaded from a JSON configuration file, this will be the name of the key.

Returns nothing.

enable('featureName')

Enables a given feature 'featureName'. Calling flipit.enable() with a feature that is already enabled is a no-op, not an error.

  • 'featureName': The name of the feature flag/switch. If loaded from a JSON configuration file, this will be the name of the key.

Returns nothing.