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

festoon

v0.0.4

Published

decorate your express requests with data

Downloads

2

Readme

Festoon

travis badge

Festoon makes it easy to "decorate" Express--or other Node-based web server--apps with data, and makes integrating small-ish tabular data sets into your web apps a piece of cake. Here's a taste:

var Festoon = require('festoon');

var data = new Festoon({
  sources: {
    people: 'people.csv'
  }
});

What's happening here? We've created a Festoon instance and registered one named data source, people, which will load data from people.csv. Next, let's create an Express server and "decorate" the response object with that data:

var express = require('express');
var app = express();

app.get('/', data.decorate('people'), function(req, res) {
  return res.render('index.html');
});

app.listen(1337, function(error) {
  var addr = this.address();
  console.log('listening @ http://%s:%s', 
});

When express renders index.html, the underlying template engine will get an array of parsed rows from people.csv in the people key of its res.locals object.

So data.decorate() takes one or more data source names (which can be specified in a number of ways), and will populate the response locals with the corresponding data, loaded fresh at runtime. You describe your data sources declaratively, and Festoon will load them as needed.

Festoon also knows about placeholders in data source filenames. Say, for instance, that you have detailed information for each of your people in a directory structure like:

people/
  betty.json
  bobby.json
  ...

Then we can do this:

data.setSource('person', 'people/:person.json');

app.use('/people/:person', data.decorate('person'), function(req, res) {
  return res.render('person.html');
});

Behind the scenes, Festoon interpolates the person parameter of the request into each of the requested data source filenames, so:

URL: 'people/betty' -> {person: 'betty'} -> data: 'people/betty.json'

Festoon will also raise errors when either the interpolation variable (in this case, person) isn't available as a request URL or query parameter.