1.0.0 • Published 8 years ago

mu-koan-server v1.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
8 years ago

mu-kōän-server 公案-閉鎖

Build Status

Graceful shutdown decorator for node's http(s) server

npm i --save mu-koan-server

js-semistandard-style

Usage

Wrap an instance of a server implementation (such as node's http or https) with a custom shutdown function that enables graceful termination of pending requests before killing the process by calling the createServer exported function.

'use strict';
/**
 * Configures a Koa app and exports 
 * a decorated node `https` server.
 */
const Koa = require('koa');
const server = require('mu-koan-server');

// Create Koa app instance
let app = new Koa();

// Create https server and export it
module.exports = server.createServer(app, {
  // Time (ms) before forced shutdown.
  // Default: 5000
  timeout: 2000,
  // Server implementation to use.
  // Default: `http`
  provider: require('https')
});

The returned server uses app.callback() as its request listener.


License

MIT

1: https://npmjs.org/http-shutdown: https://nodejs.org/api/http.html#http_http_createserver_requestlistener