fix: move server options into factory function

---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: passed
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: passed
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---

Author: kgryte

lib/node_modules/@stdlib/net/http-server/README.md

@@ -40,8 +40,8 @@ var httpServer = httpServerFactory();
 
 The function supports the following parameters:
 
--   **options**: options.
--   **requestListener**: callback to invoke upon receiving an HTTP request.
+-   **options**: options (_optional_).
+-   **requestListener**: callback to invoke upon receiving an HTTP request (_optional_).
 
 To bind a request callback to a server, provide a `requestListener`.
 
@@ -54,7 +54,7 @@ function requestListener( request, response ) {
 var httpServer = httpServerFactory( requestListener );
 ```
 
-The function accepts the following options:
+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`.
@@ -84,7 +84,7 @@ 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( \[options,] done )
+#### httpServer( done )
 
 Creates an [HTTP][nodejs-http] server.
 
@@ -104,7 +104,6 @@ httpServer( done );
 
 The function supports the following parameters:
 
--   **options**: server options which are passed directly to [`http.createServer`][nodejs-http-create-server]. Which options are supported depends on the Node.js version. Older Node.js versions (e.g., <= v8.12.0) do not support an options object, and, for those versions, a provided options object is ignored.
 -   **done**: callback to invoke once a server is listening and ready to handle requests.
 
 </section>
@@ -115,6 +114,7 @@ The function supports the following parameters:
 
 ## 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 specific to Node.js 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.
 
 </section>

lib/node_modules/@stdlib/net/http-server/docs/repl.txt

@@ -2,6 +2,12 @@
 {{alias}}( [options,] [requestListener] )
     Returns a function to create an HTTP server.
 
+    In addition to options documented below, the function supports any options
+    supported by `http.createServer`. 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`, and, for those
+    versions, any options specific to Node.js are ignored.
+
     Parameters
     ----------
     options: Object (optional)
@@ -47,14 +53,11 @@
     <Function>
 
 
-httpServer( [options,] done )
+httpServer( done )
     Creates an HTTP server.
 
     Parameters
     ----------
-    options: Object (optional)
-        Server options which are passed directly to `http.createServer`.
-
     done: Function
         Callback to invoke after creating a server.
 

lib/node_modules/@stdlib/net/http-server/docs/types/index.d.ts

@@ -104,7 +104,7 @@ type Callback = Nullary | Unary | Binary;
 *
 * @param done - callback to invoke after creating the server
 */
-type httpServer = ( done: Callback ) => void; // FIXME: need to allow for an `options` argument with support for built-in server options
+type httpServer = ( done: Callback ) => void;
 
 /**
 * Returns a function which creates an HTTP server.
@@ -127,6 +127,10 @@ declare function factory( requestListener?: RequestListener ): httpServer;
 /**
 * Returns a function which creates an HTTP server.
 *
+* ## Notes
+*
+* -   In addition to options documented below, the function supports any options supported by `http.createServer`. 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`, and, for those versions, any options specific to Node.js are ignored.
+*
 * @param options - server options
 * @param options.port - server port (default: 0)
 * @param options.maxport - max server port
@@ -154,7 +158,7 @@ declare function factory( requestListener?: RequestListener ): httpServer;
 * }
 * var httpServer = factory( opts, onRequest );
 */
-declare function factory( options: Options, requestListener?: RequestListener ): httpServer;
+declare function factory<T extends Options>( options: T, requestListener?: RequestListener ): httpServer;
 
 
 // EXPORTS //

lib/node_modules/@stdlib/net/http-server/lib/main.js

@@ -23,8 +23,8 @@
 var http = require( 'http' );
 var logger = require( 'debug' );
 var isFunction = require( '@stdlib/assert/is-function' );
-var isObject = require( '@stdlib/assert/is-object' );
 var NODE_VERSION = require( '@stdlib/process/node-version' );
+var omit = require( '@stdlib/utils/omit' );
 var format = require( '@stdlib/string/format' );
 var validate = require( './validate.js' );
 var DEFAULTS = require( './defaults.json' );
@@ -35,12 +35,23 @@ var DEFAULTS = require( './defaults.json' );
 var debug = logger( '@stdlib/net/http-server' );
 var SUPPORTS_OPTIONS = ( parseInt( NODE_VERSION.split( '.' )[ 0 ], 10 ) >= 8 ); // TODO: this is an imperfect test, as options only added in v8.12.0/v9.6.0
 
+var EXCLUDE_OPTIONS = [
+	'port',
+	'maxport',
+	'hostname',
+	'address'
+];
+
 
 // MAIN //
 
 /**
 * Returns a function which creates an HTTP server.
 *
+* ## Notes
+*
+* -   In addition to options documented below, the function supports any options supported by `http.createServer`. 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`, and, for those versions, any options specific to Node.js are ignored.
+*
 * @param {Options} [options] - server options
 * @param {NonNegativeInteger} [options.port=0] - server port
 * @param {NonNegativeInteger} [options.maxport] - max server port
@@ -77,19 +88,23 @@ function factory() {
 	var hostname;
 	var options;
 	var nargs;
+	var sopts;
 	var opts;
 	var port;
 	var max;
 	var err;
+	var flg;
 
 	nargs = arguments.length;
+	sopts = {};
 	opts = {};
 	if ( nargs === 1 ) {
 		if ( isFunction( arguments[0] ) ) {
 			requestListener = arguments[ 0 ];
 		} else {
 			options = arguments[ 0 ];
 			err = validate( opts, options );
+			flg = true;
 		}
 	} else if ( nargs > 1 ) {
 		options = arguments[ 0 ];
@@ -98,10 +113,15 @@ function factory() {
 			throw new TypeError( format( 'invalid argument. Request listener must be a function. Value: `%s`.', requestListener ) );
 		}
 		err = validate( opts, options );
+		flg = true;
 	}
 	if ( err ) {
 		throw err;
 	}
+	if ( flg ) {
+		// Resolve any server-specific options which should be passed to `http.createServer`:
+		sopts = omit( options, EXCLUDE_OPTIONS );
+	}
 	if ( opts.port === void 0 ) {
 		port = DEFAULTS.port;
 	} else {
@@ -131,7 +151,6 @@ function factory() {
 	* Creates an HTTP server.
 	*
 	* @private
-	* @param {Options} [options] - server options
 	* @param {Callback} done - function to invoke after creating a server
 	* @throws {TypeError} must provide a function
 	*
@@ -145,34 +164,20 @@ function factory() {
 	* }
 	* httpServer( done );
 	*/
-	function httpServer( options, done ) {
+	function httpServer( done ) {
 		var server;
-		var nargs;
-		var opts;
-		var cb;
-
-		nargs = arguments.length;
-		if ( nargs < 2 ) {
-			opts = {};
-			cb = options;
-		} else {
-			opts = options;
-			if ( !isObject( opts ) ) {
-				throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', opts ) );
-			}
-			cb = done;
-		}
-		if ( !isFunction( cb ) ) {
-			throw new TypeError( format( 'invalid argument. Callback argument must be a function. Value: `%s`.', cb ) );
+
+		if ( !isFunction( done ) ) {
+			throw new TypeError( format( 'invalid argument. Callback argument must be a function. Value: `%s`.', done ) );
 		}
 		if ( requestListener ) {
 			if ( SUPPORTS_OPTIONS ) {
-				server = http.createServer( opts, requestListener );
+				server = http.createServer( sopts, requestListener );
 			} else {
 				server = http.createServer( requestListener );
 			}
 		} else if ( SUPPORTS_OPTIONS ) {
-			server = http.createServer( opts );
+			server = http.createServer( sopts );
 		} else {
 			server = http.createServer();
 		}
@@ -210,7 +215,7 @@ function factory() {
 		function onListen() {
 			var addr = server.address();
 			debug( 'HTTP server initialized. Server is listening for requests on %s:%d.', addr.address, addr.port );
-			cb( null, server );
+			done( null, server );
 		}
 	}
 }