quinn

Quinn

A web framework designed for things to come.^[1]

import { createServer } from 'http';
import { createApp, respond } from 'quinn';

const app = createApp(req => respond({ body: 'Hello World!' }));

createServer(app).listen(3000);

Concepts

Request handler

A potentially async function that takes a request and returns a response.

function handler(request) {
  return result;
}

Request

An http.IncomingMessage. There are no additional properties or magical extension methods.

DispatchResult

Either a VirtualResponse^[2] or undefined. If it's undefined, the handler was unable to handle the given request. E.g. the handler implements routing logic and no route matched the given url.

respond

The respond function is the primary means to create VirtualResponse instances. It takes one of three possible values:

• An existing VirtualResponse instance that will be returned unchanged. This ensures that calling respond multiple times is idempotent.
• A response body (see below).
• An object with any combination of numeric statusCode, headers object, and/or a body property.

The body can be one of the following:

• A buffer or Uint8Array.
• A string.
• A readable stream.
• An empty body can be expressed by passing null.
• A function that takes a request and a response and returns one of the previous types. This variant is called a "lazy body" and can be used to delay serialization or returns bodies that depend on the incoming request as with JSONP responses.

VirtualResponse

A pass-through stream describing the response that should be returned. While it might have additional utility functions, only the following properties and methods should be relied on:

• response.setHeader(name, value)
• response.getHeader(name)
• response.removeHeader(name)
• response.statusCode
• response.write(chunk[, encoding][, callback])
• response.end([data][, encoding][, callback])

The behavior of each should match ServerResponse. All headers and the status code should be forwarded when the response is piped to a target. The statusCode by setting the property, the headers by calls to setHeader on the target, one header at a time.

A VirtualResponse can either be piped to a target stream or forwarded using response.forwardTo(req, res). Lazy bodies are only supported when using forwardTo. When using forwardTo, it will return a promise that resolves once the response has been successfully written.

Combining Quinn

With Express

import express from 'express';
import { createApp as quinn, respond } from 'quinn/express';

const app = express();
app.get('/quinn-route', quinn(req => respond({ body: 'Hello World!' })));

References

Similar Libraries

Most of these are based on JSGI. Which would make sense if node wouldn't include an http server.

• mikeal/response
• q-io
• bogart
• mach

---

^[1] In other words: an experimental mess.

^[2] Because buzz word.

Changelog

3.3.0

• Get the package back in shape - @jkrems #3
  • 21cab91 test: Update tests to make build pass again
  • 8972af0 chore: Use standard project layout
  • c72cf12 refactor: Apply latest project template and lint settings
  • 9a6ec1e style: Remove duplicate license headers
  • 4512c2b feat: Support lazy and stream bodies
  • 987d61c feat: Set a default body
  • 90b410c docs: Document updated interface