old-README.md

HTTP-box

HTTP-box is a lightweight http Node.js JavaScript library, inspired from Express.js and its router system.

You can use it to easily setup a modular http server.

Installation

Dependencies

Node.js and TypeScript are required. You can install TypeScript using npm.

npm i typescript

Build

Then you have to build the project :

npm run build

This will build the project in dist/lib/. The entry point of the library is lib.js.

Documentation

For more details on the different apis, check the documentation.

Usage examples

Simple server :

import { HTTPServer, RequestStatus } from 'http-box'; // or the path to lib/lib.js
const port = 3000;
const server = new HTTPServer({ port }); // create the server

server.get('/', (req, res) => {
    res.send('Welcome to the root !');
    return RequestStatus.Done; // tell the server the request has been handled
});

server.post('/echo', (req, res) => {
    let { body } = req;
    res.send(body); // send the request's body back
    return RequestStatus.Done;
});

server.start(() => console.log(`Server open at http://localhost:${port}`));

Here, a new server is created with the class HTTPServer. Then, with the <HTTPServer>.get() and <HTTPServer>.post() methods, two handlers are created, one at the root path / and an other at /echo. Finally, the server is started with <HTTPServer>.start().

Using routers :

import { HTTPServer, Router, RequestStatus } from 'http-box';
const port = 3000;
const server = new HTTPServer({ port });

const apiRouter = new Router;

apiRouter.use('/', (req, res) => {
    if (isAuthValid(req)) {
        req.data.authenticated = true;
        return RequestStatus.Next; // go to the next handler
    } else {
        res.status(401);
        res.end('Bad auth');
        return RequestStatus.Done;
    }
});

apiRouter.get('/timestamp', (req, res) => {
    res.send(Date.now().toString());
    return RequestStatus.Done;
});

server.use('/api', apiRouter); // mount the router on the path /api

server.start(() => console.log(`Server open at http://localhost:${port}`));

The apiRouter is created with the class Router. The method <Router>.use() add a handler which triggers on any request at the given path, here the root / of the router. A handler can be a callback function, or even an entire router : the line server.use('/api', apiRouter) mount the api router at the route /api of the server. So we can access the timestamp route at http://localhost:3000/api/timestamp.