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

req.relay

v1.2.0

Published

Create sequences of async handler functions for nodejs servers.

Downloads

5

Readme

REQRELAY

$ npm install req.relay

Middleware have one major drawback.

Nodejs middleware handle requests via side effects, and it makes error handling a real bummer. REQRELAY let's you use pure-er functions that throw or return. Just pass a set of plaino req+res handlers to REQRELAY and it binds them into an asynchronous chain, so they do the same work as middleware, but without the baggage.

function myHandler(req, res) {
  if (!condition) throw new Error('500: Bad!')
  return db.insert(value)
}
REQRELAY(myHandler, handler2, handlerN)

myHandler simply throws when it encounters an error—there is no next(). REQRELAY will catch the error and pass it to its default error handler, or to an error handler you've defined. No more node server crashes means no more managing clusters.

Simple, Flexible API

Pass handler functions to REQRELAY as a list:

REQRELAY(handler1, handler2, handlerN)

Optionally specify a URI path condition:

REQRELAY(handler1, handler2, handlerN)('/some-path/')

Each handler is of the form:

function(req, res) {
  // You may:
  // - throw an error
  // - return an ordinary value
  // - return a promise
  // - implicitly return undefined
}

When the handler has finished work (sync or async), if res.headersSent is false, the next function runs, and so on until the headers are sent, or there are no handler functions left.

Error Handling

If there is an uncaught error, REQRELAY will catch it and pass it to its error catch handler. You can customize each relay's error handler as follows:

REQRELAY.onError = function (req, res, err) {
  res.end('Error!')
}

Nest, mix, and compose.

REQRELAY(
  REQRELAY(publicSite),
  auth,
  REQRELAY(admin1, admin2)('/admin/'),
  REQRELAY(api1, api2)('/api/'),
  notFound
)

Use it with plain nodejs.

const http = require('http')
const REQRELAY = require('req.relay')
const myHandler1 = require('./...')
const myHandler2 = require('./...')

const relay = REQRELAY(myHandler1, myHandler2)
http.createServer(relay).listen(3000)

Use it with ExpressJS.

You can use REQRELAY with ExpressJS to take advantage of everything the community offers, while writing your own handlers in a more rarefied way. For example:

const express = require('express')
const REQRELAY = require('req.relay')
const compression = require('compression')
const myHandler1 = require('./...')
const myHandler2 = require('./...')
const app = express()

// Third party middleware:
app.use(compression)

// return-throw-friendly handlers:
const relay = REQRELAY(myHandler1, myHandler2)
app.use(relay)
app.listen(3000)