## Usage ```javascript var httpServerFactory = require( '@stdlib/net-http-server' ); ``` #### httpServerFactory( \[options,] \[requestListener] ) Returns a function to create an [HTTP][nodejs-http] server. ```javascript var httpServer = httpServerFactory(); ``` The function supports the following parameters: - **options**: options (_optional_). - **requestListener**: callback to invoke upon receiving an HTTP request (_optional_). To bind a request callback to a server, provide a `requestListener`. ```javascript function requestListener( request, response ) { console.log( request.url ); response.end( 'OK' ); } var httpServer = httpServerFactory( requestListener ); ``` In addition to the options supported by [`http.createServer`][nodejs-http-create-server], the function accepts the following options: - **port**: server port. Default: `0` (i.e., randomly assigned). - **maxport**: max server port when port hunting. Default: `maxport=port`. - **hostname**: server hostname. - **address**: server address. Default: `127.0.0.1`. To specify server options, provide an options object. ```javascript var opts = { 'port': 7331, 'address': '0.0.0.0' }; var httpServer = httpServerFactory( opts ); ``` To specify a range of permissible ports, set the `maxport` option. ```javascript var opts = { 'maxport': 9999 }; var httpServer = httpServerFactory( opts ); ``` When provided a `maxport` option, a created server will search for the first available `port` on which to listen, starting from `port`. #### httpServer( done ) Creates an [HTTP][nodejs-http] server. ```javascript function done( error, server ) { if ( error ) { throw error; } console.log( 'Success!' ); server.close(); } var httpServer = httpServerFactory(); httpServer( done ); ``` The function supports the following parameters: - **done**: callback to invoke once a server is listening and ready to handle requests.

## Notes - Which server options are supported depends on the Node.js version. Older Node.js versions (e.g., <= v8.12.0) do not support an options object when calling [`http.createServer`][nodejs-http-create-server], and, for those versions, any options supported by [`http.createServer`][nodejs-http-create-server] in later Node.js versions are ignored. - Port hunting can be useful in a microservice deployment. When a `port` is randomly assigned (`options.port=0`), if a server fails and is restarted, the server is unlikely to bind to its previous `port`. By allowing a constrained search, assuming no lower `ports` within a specified range have freed up in the meantime, the likelihood of listening on the same `port` is increased. A server can typically restart and bind to the same `port` faster than binding to a new `port` and re-registering with a microservice registry, thus minimizing possible service interruption and downtime.

## Examples ```javascript var proc = require( 'process' ); var http = require( 'http' ); var httpServerFactory = require( '@stdlib/net-http-server' ); function done( error, server ) { if ( error ) { throw error; } http.get( 'http://127.0.0.1:7331/beep/boop', onResponse ); } function onResponse() { console.log( 'Success!' ); proc.exit( 0 ); } function onRequest( request, response ) { console.log( request.url ); response.end( 'OK' ); } // Specify server options... var opts = { 'port': 7331, 'maxport': 9999, 'hostname': 'localhost' }; // Create a function for creating an HTTP server... var httpServer = httpServerFactory( opts, onRequest ); // Create a server: httpServer( done ); ```

* * * ## Notice This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib]. #### Community [![Chat][chat-image]][chat-url] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].

[npm-image]: http://img.shields.io/npm/v/@stdlib/net-http-server.svg [npm-url]: https://npmjs.org/package/@stdlib/net-http-server [test-image]: https://github.com/stdlib-js/net-http-server/actions/workflows/test.yml/badge.svg?branch=v0.2.4 [test-url]: https://github.com/stdlib-js/net-http-server/actions/workflows/test.yml?query=branch:v0.2.4 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/net-http-server/main.svg [coverage-url]: https://codecov.io/github/stdlib-js/net-http-server?branch=main [chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg [chat-url]: https://stdlib.zulipchat.com [stdlib]: https://github.com/stdlib-js/stdlib [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors [umd]: https://github.com/umdjs/umd [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules [deno-url]: https://github.com/stdlib-js/net-http-server/tree/deno [deno-readme]: https://github.com/stdlib-js/net-http-server/blob/deno/README.md [umd-url]: https://github.com/stdlib-js/net-http-server/tree/umd [umd-readme]: https://github.com/stdlib-js/net-http-server/blob/umd/README.md [esm-url]: https://github.com/stdlib-js/net-http-server/tree/esm [esm-readme]: https://github.com/stdlib-js/net-http-server/blob/esm/README.md [branches-url]: https://github.com/stdlib-js/net-http-server/blob/main/branches.md [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/net-http-server/main/LICENSE [nodejs-http]: https://nodejs.org/api/http.html [nodejs-http-create-server]: https://nodejs.org/api/http.html#httpcreateserveroptions-requestlistener