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

xpr-express

v1.0.10

Published

Express.js plugin for XPRMNTL feature-client

Downloads

9

Readme

XPRMNTL

XPR-Express.js

NPM version Downloads Tips

This is a Node.js plugin for XPRMNTL feature-client. It adds the ability to call req.feature from within an express.js app. req.feature('expName') returns the value of the feature.

Installation

$ npm install xpr-express

API

var featureClient = require('feature-client');
var xprExpress = require('xpr-express');
var app = require('express')();
var cookieParser = require('cookie-parser');

featureClient.use(xprExpress());
app.use(cookieParser());
app.use(featureClient.express);

app.get('/', function() {
  if (req.feature('featureName')) {
    // Do something with feature on
  } else {
    // Do something for feature off
  }
});

xprExpress(config)

  • config.cookieName is used if no readExps/saveExps are defined. Feature configuration is stored in the user's cookie as needed.

  • config.readExps is a function with the following footprint:

    Defaults to reading an experiment cookie (config.cookieName)

    function(req, res) {
      // read experiment data from express `req` and `res` or other means
      return experiments; // see Experiment Format
    }
  • config.saveExps is a function with the following footprint:

    Defaults to writing an experiment cookie (config.cookieName)

    function(userID, experiments, res) {
      // Save experiment configuration to express `res` or other means
    
      return; // nothing
    }
  • Experiment Format:

    {
      userID: userID,
      bucket: bucketNumber, // 0-99
      app: {
        userID: userID,
        bucket: bucketNumber, // May be different
        stamp: someHash, // Used to determine when out-of-date
        features: {}, // Key,value of what is already used for this user
        dirtyFeatures: {}, // Used to override library experiments with `this.features`
      },
      shared: {} // Same format as `this.app`
    }

Added feature-client functionality

  • featureClient.express is the express middleware that is added to featureClient. It attaches the req.feature() function to the req object.
  • req.feature is a function that determines if a user has an experiment enabled.

Setting features via url

As of v1.0.0, you now have the ability to turn experiments on/off via the url. This is only on a per-user basis, similar to xpr-toggle.

Example [appUrl]/[path]/?xpr.featName1=true - Sets feature "featName1" to true [appUrl]/[path]/?xpr.featName1=false&featName=true - Sets feature "featName1" to false and "featName2" to true

This also allows you to enable features that normally would not show up in the list (secret features).

FAQ

  1. The default read/write methods are not working.
  • Make sure you are using express.cookieParser before featureClient.express. This is not done for you in case you do your own state lookups.