Skip to content

A collection of middlewares that can be used in combination with the @neobeach/core package

License

Notifications You must be signed in to change notification settings

neobeach/middlewares

Repository files navigation

neobeach/middlewares

Repository containing middlewares implementations based on the @neabeach/core.

What are middlewares

Middleware functions are functions that have access to the request object (req), the response object (res), and the next function in the application’s request-response cycle. The middleware functions will be performed on every request made to the application. It is used to perform certain actions before the page is loaded.

How to implement middlewares in neobeach

To implement middlewares you have to first require them in the server.js file. After this you have to load them in via server.loadMiddlewares functions inside Runtime. You can collect the middleware functions together in one array and load them all at once.

Example from the server.jsfile.

const {Runtime, Server} = require('@neobeach/core');
const requestLogger = require('@neobeach/middlewares-request-logger');
const oldBrowser = require('@neobeach/middlewares-old-browser');
const pwa = require('@neobeach/middlewares-pwa');

const server = new Server();

/**
 * Define global middlewares
 */
const globalMiddleware = [
    requestLogger(),
    oldBrowser(),
    pwa()
];

/**
 * Create a runtime/sandbox to start the server in
 */
Runtime(() => {
    server.includeDefaultBodyParsers();
    server.loadMiddlewares(globalMiddleware);
    server.loadRouters(routers);
    server.run();
});

Create middlewares yourself

If you have a middleware that you want to include look at the other middlewares as a template. When you are done with them, and they are tested create a pull request in @neobeach/middlewares.

Structure

The base structure of the middlewares is as follows.

middleware/
    package.json            <- Package.json containing metadata + dependencies needed.
    index.js                <- Export of the function that is inside the middleware.

JSDocs

Inside the middleware we follow the JSDocs documentation. Reason for this is that we write the documentation while we write our code. The JSDocs need to contain types on function parameters and an example on how to implement the code.

License

MIT

About

A collection of middlewares that can be used in combination with the @neobeach/core package

Topics

Resources

License

Stars

Watchers

Forks