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

neff

v1.5.0

Published

nconf & express based features flags

Downloads

23

Readme

Neff is simple express middleware for handling feature flags.

Usage

The standard way to use neff on the client & the server side is to check for enabled features using the isEnabled() API.

var users = 500;
var moreUsers = neff.isEnabled("moreUsers");
if (moreUsers) {
    users++;
}

Argument-Based Config

To get started with neff you'll want to make sure you call neff, passing it an object with feature names and either true or false values.

var neff = require("neff")({
	"feature1": true,
	"feature2": false
});
app.use(neff);

NConf-Based Config

If you'd like to utilize NConf for this, you can reference an NConf JSON file and my config looks like this:

"features": {
    "feature1": true,
    "feature2": false
}

Then pass the config object for the features to neff:

var neff = require("neff")(nconf.get('features'));
app.use(neff);

Accessing in templates

The first thing it allows you to do is access feature flags directly in your template such as (dust syntax):

{?feature-feature1}
MY HIDDDEN CODE
{/feature-feature1}

Express Router Limiter

This route is only available when the feature flag is enabled. Otherwise the user would see a server error page.

var neff = require("neff");
app.get("/myhidden/route", neff.limit("feature1"), function(req, res) {
   res.send("You have found feature1!");
});

Client Side Usage

It also provides a string of class names you can insert into your <body> (dust syntax):

<body class="{featureClasses}">

The output prepends feature- to the classname, so you might see something like <body class="feature-feature1"> with the config above. Only enabled features show up in the string.

Make sure your features are declared on your DOM like so:

<body class="feature-feature1 feature-feature2">

Once you've done that you can take advantage of the flags in 2 ways.

CSS

/* Create a block that's hidden by default */
.my-cool-block {
	display: none;
}

/* Display that block when your flag is present */
.feature-feature1 .my-cool-block {
	display: block;
}

JavaScript

define(["neff"], function(neff) {
	if (neff.isEnabled("feature1")) {
		/* .. */
	}
});

Thanks

Inspired heavily by https://npmjs.org/package/feature-gateway.