0.1.1 • Published 7 years ago

pr-express-server v0.1.1

Weekly downloads
1
License
MIT
Repository
gitlab
Last release
7 years ago

pr-express-server

ExpressJS based server with useful middlewares

Philosophy

Simple and ready-to-use express-server pre-loaded with commonly used middleware provided as a starting point for development

Installation

$ npm install pr-express-server

APIs

The module exposes a simple create-function and returns an ExpressJS app with pre-loaded middleware. These middleware can be configured via options passed to the function. The app also has updated methods to start/listen and stop/close the server.

var server = require("pr-express-server");

// create server
var app = server(options);

// setup the business-login as would with an express-app
app.set(); // properties
app.use(); // handlers

// start
app.listen(callback);

// stop
app.close(callback);

Following is the list of middleware that are pre-loaded and configurable via options - you may refer to the documentation of the respective modules for options:

TypeOption-keyDocumentation
Req/Res LoggerwinstonHttpLoggerexpress-winston
Overload Protectiontoobusytoobusy-js
Request IDrequestIDkey: name; generator: function
Request LoggerrequestLoggerkey: name; logger: logger-object
HTTP Compressioncompressioncompression
Req Body-parserbodyParserexpress-body-parser
Security Headershelmethelmet
Cookie SessionredisCookieSessionexpress-redis-session
WebsocketsexpressWsexpress-ws
Sockets MonitoringwsMonitorws-monitor
Listening Portporthttp-port

Refer to default options for reference at: defaults.js

Usage

Refer to test server.js implementation for usage details.

Test

$ npm install # inside pr-express-server
$ npm test