Disposable HTTP Server

Create a disposable HTTP server.

Installation

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

Usage

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

httpServer( options[, clbk] )

Creates a disposable HTTP server; i.e., the server closes immediately after serving provided content.

var opts = {
    'html': '<script src="/bundle.js"></script>',
    'javascript': 'console.log( "Boop" );'
};

httpServer( opts );

The function accepts the following options:

• html: buffer or string to serve as HTML content.
• javascript: buffer or string to serve as JavaScript.
• 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. Default: false.

To serve HTML content, set the html option. Once the content is requested, the server will close.

var opts = {
    'html': '<h1>Beep</h1>'
};

httpServer( opts );

To serve JavaScript, set the javascript option. If no HTML is provided, an HTML boilerplate is served and the JavaScript is served as /bundle.js. Once the content is requested, the server will close.

var opts = {
    'javascript': 'console.log( "Boop" );'
};

httpServer( opts );

If HTML and JavaScript are provided, in order for the JavaScript to be served, the HTML content should request the file /bundle.js.

var opts = {
    'html': '<script src="/bundle.js"></script>',
    'javascript': 'console.log( "Boop" );'
};

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();
    }
}

var opts = {
    'html': html,
    'javascript': 'console.log( "Boop" );'
};

httpServer( opts, onReady );

Notes

• If neither the html or javascript option is set, the server serves an HTML boilerplate and then closes.

Examples

var join = require( 'path' ).join;
var readFileSync = require( '@stdlib/fs-read-file' ).sync;
var httpServer = require( '@stdlib/net-disposable-http-server' );

var html = join( __dirname, 'examples', 'fixtures', 'index.html' );
var js = join( __dirname, 'examples', 'fixtures', 'script.js' );

var opts = {
    'html': readFileSync( html ),
    'javascript': readFileSync( js ),
    '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();
    }
}

See Also

• @stdlib/net-disposable-http-server-cli: CLI package for use as a command-line utility.

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.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.