@stdlib/net-simple-http-server NPM

Simple HTTP Server

Create a simple HTTP server.

Installation

npm install @stdlib/net-simple-http-server

Usage

var httpServer = require( '@stdlib/net-simple-http-server' );

httpServer( [options,] [clbk] )

Creates a simple HTTP server.

// Serve from the current working directory of the calling process:
httpServer();

The function accepts the following options:

dir: directory from which to serve files.
port: server port. Default: 0 (i.e., randomly assigned).
maxport: max server port (used when port hunting). Default: =port.
hostname: server hostname.
address: server address. Default: "0.0.0.0".
open: boolean indicating whether to launch a web browser.

By default, the server serves content from the current working directory of the calling process. To serve from an alternative directory (resolved relative to the current working directory), set the dir option.

var opts = {
    'dir': './examples'
};
httpServer( opts );

To obtain the server handle, provide a callback.

var nextTick = require( '@stdlib/utils-next-tick' );

function onReady( error, server ) {
    if ( error ) {
        throw error;
    }
    nextTick( close );
    function close() {
        server.close();
    }
}
httpServer( onReady );

Examples

var httpServer = require( '@stdlib/net-simple-http-server' );

var opts = {
    'dir': './',
    'port': 7331,
    'hostname': 'localhost',
    'open': false
};

httpServer( opts, clbk );

function clbk( error, server ) {
    if ( error ) {
        throw error;
    }
    // Give the user a few seconds to open her web browser before closing the server...
    setTimeout( onTimeout, 5000 );

    function onTimeout() {
        server.close();
    }
}

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.