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

promised-routing

v1.0.0

Published

Dead simple ExpressJS routes with promises

Downloads

3

Readme

Promised routing

Build Status npm version

Dead simple ExpressJS routes for developers using promises.

Motivation

You know how funny it can be to code asynchronously?

app.get('/my/route/:id', function(req, res) {
  findObjFromDb(req.params.id, function(err, obj) {
    if (err) {
      res.status(500).send(err.toString())
    } else {
      findAnotherObjFromDb(data, function(err, another) {
        if (err) {
          res.status(500).send(err.toString())
        } else {
          res.json({obj: obj, another: another})
        }
      })
    }
  })
})

Terrible? Definitely.

Ok, promises can make your async life a little bit easier:

app.get('/my/route/:id', function(req, res) {
  findObjFromDb(req.params.id)
    .then(findAnotherObjFromDb)
    .then(function(combined) {
      res.json(combined)
    }
    .catch(function(error) {
      res.status(500).send(error.toString())
    })
    .done()
})

Well, that looks like a lot better! However, there is still some boilerplate in that code: the last then, catch and done are basically same for all routes. Doh!

Here promised-routing comes to rescue:

var routing = require('promised-routing')
...
app.get('/my/route/:id', routing.json(function(req) {
  return findObjFromDb(req.params.id)
    .then(findAnotherObjFromDb)       
}))

Simple, lightweight, tested and beautiful.

:+1:

API

.json((request [, response]) => value|promise(value)) => routeHandler

Creates an express route that returns Content-Type: application/json with 200 code and JSON body. The returned JSON body can be wrapped to promise so that it'll be sent asynchronously when the promise completes.

var routing   = require('promised-routing'),
    Bluebird = require('bluebird')

app.get('/tsers/:name', routing.json(function(req) {
  return Bluebird.resolve({msg: 'Tsers ' + req.params.name + '!'})
}))

.jsonp((request[, response]) => value|promise(value)) => routeHandler

Behaves exactly same like .json(..) but uses res.jsonp for response sending instead of res.json. All express configurations to Express application apply here.

.custom(mimeType, (request [, response]) => value|promise(value)) => routeHandler

Creates an express route that returns the user selected mime type as response's Content-Type. The body is returned with response.send() so all express supported types can be returned. Like in JSON routes, both synchronous and asynchronous (= promises) values are supported.

var routing   = require('promised-routing')

app.get('/tsers/:filename', routing.custom('application/octet-stream', function(req, res) {
  res.set('Content-Disposition', 'attachment;filename=' + req.params.filename)
  return new Buffer('tsers!', 'utf8')
}))

.configure(opts) => routing

Creates a new routing object with overridden options.

var routing = require('promised-routing')

var custom = routing.configure({errorHandler: function(res, error) { res.status(200).send('ok?') }})

app.get('/my/route', custom.json(function(req) {
  // ...
}))