nof

noflow

A minimal server middleware composer for the future.

Showing:

Popularity

Downloads/wk

32

GitHub Stars

33

Maintenance

Last Commit

4yrs ago

Contributors

4

Package

Dependencies

1

Size (min+gzip)

3.2KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

NoFlow

A minimal server middleware composer for the future. Mostly, It is used to create http server and handle proxy. The interesting part is that it also works fine without any ES6 or ES7 syntax, it's up to you to decide how fancy it will be. And because its middlewares are just normal functions, they can be easily composed with each other.

To use noflow, you only have to remember a single rule "Any async function should and will return a Promise".

Features

  • Super lightweight, only one dependency, 200 sloc, learn it in 5 minutes
  • Static-typed with typescript
  • Faster than Express.js and Koa, see the benchmark section
  • Based on Promise, works well with async/await
  • Supports almost all exist Express-like middlewares

For examples, goto folder examples.

To run the examples, you have to install the dependencies of this project: npm i. Such as, to run the examples/basic.js, use command like: node_modules/.bin/noe examples/basic.js

NPM version Build Status Build status Deps Up to Date

Quick Start

Install it: npm i noflow.

Hello World Example

import flow from "noflow";

let app = flow();

// Anything pushed into the app will be converted to a
// middleware object sanely, even it's a string, buffer, stream or anything else.
// Here we created a server that responses only string "hello world".
app.push("hello world");

app.listen(8123);

ES5

Without ES7, you can still have all the goodies.

var flow = require("noflow").default;

var app = flow();

app.push(function ($) {
    return $.next().then(function () {
        console.log("done");
    });
});

app.push(function ($) {
    $.body = "hello world";
});

app.listen(8123);

ES7

Designed for the future ES7.

import flow from "noflow";

let app = flow();

app.push(

    async ({ next }) => {
        await next();
        console.log("done");
    },

    $ => $.body = "hello world"

);

app.listen(8123);

Routes

You can write routes quickly by using select interface of NoKit.

import flow from "noflow";
import kit from "nokit";
let { match, select } = kit.require("proxy");

let app = flow();

app.push(
    select("/test", $ => $.body = $.url),

    select(
        // Express.js like url selector.
        match("/items/:id"),
        $ => $.body = $.url.id
    ),

    select(
        {
            url: "/api",
            method: /GET|POST/ // route both GET and POST
        },
        $ => $.body = $.method + " " + $.url
    ),

    select(
        {
            // route some special headers
            headers: {
                host: "a.com"
            }
        },
        $ => $.body = "ok"
    )
);

app.listen(8123);

Express middleware

It's easy to convert an express middleware to noflow middleware.

import flow from "noflow";
import bodyParser from "body-parser";

let app = flow();

let convert = (h) => ({ req, res, next }) =>
    new Promise((resolve, reject) =>
        h(req, res, (err) => {
            if (err)
                return reject(err);
            else
                return next().then(resolve);
        })
    );

app.push(
    convert(bodyParser.json()),
    $ => {
        $.body = $.req.body;
    }
);

app.listen(8123);

API

It's recommended to use typescript to check all the API details.

  • flow()

    Create an array instance with some handy server helper methods.

    • param:

      FlowArray middlewares Optional. If not provided, the return type will be a FlowArray, else a middleware Function.

    • return:

      FlowArray | Function

    • example:

      import flow from "noflow"
      let app = flow();
      app.push("OK");
      app.listen(8123).then(() => console.log("started"));
      

Status code

Noflow will auto handle status code 200, 204, 404 and 500 for you only if you haven't set the status code yourself.

  • 204: If you don't set $.body, such as it's null or undefined.

  • 404: If no middleware found.

  • 500: If any middleware reject or throws an error.

  • userDefined: If user set the $.res.statusCode manually.

  • 200: If none of the above happens.

Error handling

A middleware can catch all the errors of the middlewares after it.

With ES5, you can use it like normal promise error handling:

var flow = require("noflow").default;

var app = flow();

app.push(function ($) {
    return $.next().catch(function (e) {
        $.body = e;
    });
});

app.push(function () {
    throw "error";
});

app.push(function () {
    // Same with the `throw "error"`
    return Promise.reject("error");
});

app.listen(8123);

With ES7, you can use try-catch directly:

import flow from "noflow";

let app = flow();

app.push(async ($) => {
    try {
        await $.next();
    } catch (e) {
        $.body = e;
    }
});

app.push(() => {
    throw "error";
});

app.listen(8123);

NoKit

Noflow relies on the async nature of Promise, when you need async io tools, nokit will be the best choice. nokit has all the commonly used IO functions with Promise support.

For example you can use them seamlessly:

import flow from "noflow";
import kit from "nokit";
let { select } = kit.require("proxy");

let app = flow();

app.push(
    select(
        "/a",
        kit.readJson("a.json") // readJson returns a Promise
    ),

    select("/b", async $ => {
        let txt = await kit.readFile("b.txt");
        let data = await kit.request("http://test.com/" + $.url);
        $.body = txt + data;
    })
);

app.listen(8123).then(() => {
    kit.request('127.0.0.1:8123/a').then(kit.logs);
});

Benchmark

These comparisons only reflect some limited truth, no one is better than all others on all aspects. You can run it yourself in terminal: npm run no -- benchmark.

Node v5.4.0
The less the better:
noflow: 1839.333ms
koa: 2598.171ms
express: 3239.013ms

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100