node-nailgun-server

0.3.0 • Public • Published

node-nailgun-server

A Node.js module for running Nailgun servers.

npm Version Build Status js-standard-style

This package enable you to run Nailgun servers through your Node.js applications.

Note that this only provides support for running Nailgun servers. If you are need of a Nailgun client for Node.js, node-nailgun-client is recommended.

Install

npm install node-nailgun-server

Example

By the default the server will listen to all interfaces on port 2113.

const nailgun = require('node-nailgun-server');
 
const server = nailgun.createServer();
server.out.pipe(process.stdout);

In the following example node-nailgun-client is used to communicate with the server:

const nailgun = require('node-nailgun-server');
const client = require('node-nailgun-client');
 
const options = {
  address: 'localhost',
  port: 0, // 0 lets the server choose a random port
}
 
nailgun.createServer(options, function(port) {
  const nail = client.exec('ng-stats', { port: port })
  nail.stdout.pipe(process.stdout);
});

The server object returned when creating a server provides a output stream and also a function for shutting the server down:

server.shutdown();

Servers are also shutdown automatically when the Node.js process exits.

License

Apache License 2.0

Dependencies (0)

    Dev Dependencies (4)

    Package Sidebar

    Install

    npm i node-nailgun-server

    Weekly Downloads

    1,388

    Version

    0.3.0

    License

    Apache-2.0

    Unpacked Size

    2.68 MB

    Total Files

    5

    Last publish

    Collaborators

    • markushedvall