Merge remote-tracking branch 'upstream/develop' into stats-minabs-new

Author: stdlib-bot

lib/node_modules/@stdlib/blas/ext/base/dnansum/benchmark/c/benchmark.length.c

@@ -111,6 +111,7 @@ static double benchmark1( int iterations, int len ) {
 	v = 0.0;
 	t = tic();
 	for ( i = 0; i < iterations; i++ ) {
+		// cppcheck-suppress uninitvar
 		v = stdlib_strided_dnansum( len, x, 1 );
 		if ( v != v ) {
 			printf( "should not return NaN\n" );
@@ -148,6 +149,7 @@ static double benchmark2( int iterations, int len ) {
 	v = 0.0;
 	t = tic();
 	for ( i = 0; i < iterations; i++ ) {
+		// cppcheck-suppress uninitvar
 		v = stdlib_strided_dnansum_ndarray( len, x, 1, 0 );
 		if ( v != v ) {
 			printf( "should not return NaN\n" );

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

@@ -47,15 +47,20 @@ var opts = {
 httpServer( opts );
 ```
 
+The function supports the following parameters:
+
+-   **options**: function options.
+-   **clbk**: callback to invoke upon creating a server (_optional_).
+
 The function accepts the following options:
 
--   **html**: `buffer` or `string` to serve as HTML content.
--   **javascript**: `buffer` or `string` to serve as JavaScript.
+-   **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`.
+-   **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.
 
@@ -127,7 +132,7 @@ httpServer( opts, onReady );
 
 ## Notes
 
--   If neither the `html` or `javascript` option is set, the server serves an HTML boilerplate and then closes.
+-   If neither the `html` nor `javascript` option is set, the server serves an HTML boilerplate and then closes.
 
 </section>
 

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

@@ -20,24 +20,29 @@ limitations under the License.
 
 # HTTP Server
 
-> [HTTP][http] server.
+> [HTTP][nodejs-http] server.
 
 <section class="usage">
 
 ## Usage
 
 ```javascript
-var httpServer = require( '@stdlib/net/http-server' );
+var httpServerFactory = require( '@stdlib/net/http-server' );
 ```
 
-#### httpServer( \[options,] \[ requestListener] )
+#### httpServerFactory( \[options,] \[requestListener] )
 
-Returns a function to create an [HTTP][http] server.
+Returns a function to create an [HTTP][nodejs-http] server.
 
 ```javascript
-var createServer = httpServer();
+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
@@ -46,25 +51,25 @@ function requestListener( request, response ) {
     response.end( 'OK' );
 }
 
-var createServer = httpServer( requestListener );
+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`.
 -   **hostname**: server hostname.
 -   **address**: server address. Default: `127.0.0.1`.
 
-To specify server options, provide an `options` object.
+To specify server options, provide an options object.
 
 ```javascript
 var opts = {
     'port': 7331,
     'address': '0.0.0.0'
 };
 
-var createServer = httpServer( opts );
+var httpServer = httpServerFactory( opts );
 ```
 
 To specify a range of permissible ports, set the `maxport` option.
@@ -74,14 +79,14 @@ var opts = {
     'maxport': 9999
 };
 
-var createServer = httpServer( opts );
+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`.
 
-#### createServer( done )
+#### httpServer( done )
 
-Creates an [HTTP][http] server.
+Creates an [HTTP][nodejs-http] server.
 
 ```javascript
 function done( error, server ) {
@@ -92,11 +97,15 @@ function done( error, server ) {
     server.close();
 }
 
-var createServer = httpServer();
+var httpServer = httpServerFactory();
 
-createServer( done );
+httpServer( done );
 ```
 
+The function supports the following parameters:
+
+-   **done**: callback to invoke once a server is listening and ready to handle requests.
+
 </section>
 
 <!-- /.usage -->
@@ -105,6 +114,7 @@ createServer( done );
 
 ## 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.
 
 </section>
@@ -122,7 +132,7 @@ createServer( done );
 ```javascript
 var proc = require( 'process' );
 var http = require( 'http' );
-var httpServer = require( '@stdlib/net/http-server' );
+var httpServerFactory = require( '@stdlib/net/http-server' );
 
 function done( error, server ) {
     if ( error ) {
@@ -149,10 +159,10 @@ var opts = {
 };
 
 // Create a function for creating an HTTP server...
-var createServer = httpServer( opts, onRequest );
+var httpServer = httpServerFactory( opts, onRequest );
 
 // Create a server:
-createServer( done );
+httpServer( done );
 ```
 
 </section>
@@ -171,7 +181,9 @@ createServer( done );
 
 <section class="links">
 
-[http]: https://nodejs.org/api/http.html
+[nodejs-http]: https://nodejs.org/api/http.html
+
+[nodejs-http-create-server]: https://nodejs.org/api/http.html#httpcreateserveroptions-requestlistener
 
 </section>
 

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

@@ -2,6 +2,13 @@
 {{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 supported by `http.createServer` in later Node.js
+    versions are ignored.
+
     Parameters
     ----------
     options: Object (optional)
@@ -24,30 +31,30 @@
 
     Returns
     -------
-    createServer: Function
+    httpServer: Function
         Function to create an HTTP server.
 
     Examples
     --------
     // Basic usage:
-    > var createServer = {{alias}}()
+    > var httpServer = {{alias}}()
     <Function>
 
     // Provide a request callback:
     > function onRequest( request, response ) {
     ...    console.log( request.url );
     ...    response.end( 'OK' );
     ... };
-    > createServer = {{alias}}( onRequest )
+    > httpServer = {{alias}}( onRequest )
     <Function>
 
     // Specify a specific port:
     > var opts = { 'port': 7331 };
-    > createServer = {{alias}}( opts )
+    > httpServer = {{alias}}( opts )
     <Function>
 
 
-createServer( done )
+httpServer( done )
     Creates an HTTP server.
 
     Parameters
@@ -64,8 +71,8 @@ createServer( done )
     ...    console.log( 'Success!' );
     ...    server.close();
     ... };
-    > var createServer = {{alias}}();
-    > createServer( done );
+    > var httpServer = {{alias}}();
+    > httpServer( done );
 
     See Also
     --------

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 createServer = ( done: Callback ) => void;
+type httpServer = ( done: Callback ) => void;
 
 /**
 * Returns a function which creates an HTTP server.
@@ -113,20 +113,24 @@ type createServer = ( done: Callback ) => void;
 * @returns function which creates an HTTP server
 *
 * @example
-* var createServer = httpServer();
+* var httpServer = factory();
 *
 * @example
 * function onRequest( request, response ) {
 *     console.log( request.url );
 *     response.end( 'OK' );
 * }
-* var createServer = httpServer( onRequest );
+* var httpServer = factory( onRequest );
 */
-declare function httpServer( requestListener?: RequestListener ): createServer;
+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 supported by `http.createServer` in later Node.js versions are ignored.
+*
 * @param options - server options
 * @param options.port - server port (default: 0)
 * @param options.maxport - max server port
@@ -141,7 +145,7 @@ declare function httpServer( requestListener?: RequestListener ): createServer;
 *     'port': 7331,
 *     'address': '0.0.0.0'
 * };
-* var createServer = httpServer( opts );
+* var httpServer = factory( opts );
 *
 * @example
 * var opts = {
@@ -152,11 +156,11 @@ declare function httpServer( requestListener?: RequestListener ): createServer;
 *     console.log( request.url );
 *     response.end( 'OK' );
 * }
-* var createServer = httpServer( opts, onRequest );
+* var httpServer = factory( opts, onRequest );
 */
-declare function httpServer( options: Options, requestListener?: RequestListener ): createServer;
+declare function factory<T extends Options>( options: T, requestListener?: RequestListener ): httpServer;
 
 
 // EXPORTS //
 
-export = httpServer;
+export = factory;