https://github.com/stdlib-js/net-http2-secure-server
HTTP/2 secure server.
https://github.com/stdlib-js/net-http2-secure-server
create http2 javascript net network networking node node-js nodejs server stdlib
Last synced: 2 months ago
JSON representation
HTTP/2 secure server.
- Host: GitHub
- URL: https://github.com/stdlib-js/net-http2-secure-server
- Owner: stdlib-js
- License: apache-2.0
- Created: 2025-08-16T06:11:36.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2026-03-02T01:29:36.000Z (4 months ago)
- Last Synced: 2026-03-02T04:58:51.551Z (4 months ago)
- Topics: create, http2, javascript, net, network, networking, node, node-js, nodejs, server, stdlib
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 275 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
- Notice: NOTICE
Awesome Lists containing this project
README
About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
# HTTP/2 Server
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> [HTTP/2][nodejs-http2] server.
## Installation
```bash
npm install @stdlib/net-http2-secure-server
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
var http2ServerFactory = require( '@stdlib/net-http2-secure-server' );
```
#### http2ServerFactory( options\[, requestListener] )
Returns a function to create an [HTTP/2][nodejs-http2] server.
```javascript
var resolve = require( 'path' ).resolve;
var readFileSync = require( '@stdlib/fs-read-file' ).sync;
var opts = {
'cert': readFileSync( resolve( __dirname, 'examples', 'localhost-cert.pem' ) ),
'key': readFileSync( resolve( __dirname, 'examples', 'localhost-privkey.pem' ) )
};
var http2Server = http2ServerFactory( opts );
```
The function supports the following parameters:
- **options**: options.
- **requestListener**: callback to invoke upon receiving an HTTP request (_optional_).
To bind a request callback to a server, provide a `requestListener`.
```javascript
var resolve = require( 'path' ).resolve;
var readFileSync = require( '@stdlib/fs-read-file' ).sync;
function requestListener( request, response ) {
console.log( request.url );
response.end( 'OK' );
}
var opts = {
'cert': readFileSync( resolve( __dirname, 'examples', 'localhost-cert.pem' ) ),
'key': readFileSync( resolve( __dirname, 'examples', 'localhost-privkey.pem' ) )
};
var http2Server = http2ServerFactory( opts, requestListener );
```
In addition to the options supported by [`http2.createSecureServer`][nodejs-http2-create-secure-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 resolve = require( 'path' ).resolve;
var readFileSync = require( '@stdlib/fs-read-file' ).sync;
var opts = {
'port': 7331,
'address': '0.0.0.0',
'cert': readFileSync( resolve( __dirname, 'examples', 'localhost-cert.pem' ) ),
'key': readFileSync( resolve( __dirname, 'examples', 'localhost-privkey.pem' ) )
};
var http2Server = http2ServerFactory( opts );
```
To specify a range of permissible ports, set the `maxport` option.
```javascript
var resolve = require( 'path' ).resolve;
var readFileSync = require( '@stdlib/fs-read-file' ).sync;
var opts = {
'maxport': 9999,
'cert': readFileSync( resolve( __dirname, 'examples', 'localhost-cert.pem' ) ),
'key': readFileSync( resolve( __dirname, 'examples', 'localhost-privkey.pem' ) )
};
var http2Server = http2ServerFactory( opts );
```
When provided a `maxport` option, a created server will search for the first available `port` on which to listen, starting from `port`.
#### http2Server( done )
Creates an [HTTP/2][nodejs-http2] server.
```javascript
var resolve = require( 'path' ).resolve;
var readFileSync = require( '@stdlib/fs-read-file' ).sync;
function done( error, server ) {
if ( error ) {
throw error;
}
console.log( 'Success!' );
server.close();
}
var opts = {
'cert': readFileSync( resolve( __dirname, 'examples', 'localhost-cert.pem' ) ),
'key': readFileSync( resolve( __dirname, 'examples', 'localhost-privkey.pem' ) )
};
var http2Server = http2ServerFactory( opts );
http2Server( done );
```
The function supports the following parameters:
- **done**: callback to invoke once a server is listening and ready to handle requests.
## Notes
- The function requires that either the `pfx` option is provided or a `cert`/`key` option pair is provided.
- Which server options are supported depends on the Node.js version.
- 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 http2 = require( 'http2' );
var resolve = require( 'path' ).resolve;
var readFileSync = require( '@stdlib/fs-read-file' ).sync;
var http2ServerFactory = require( '@stdlib/net-http2-secure-server' );
function done( error ) {
var client;
var req;
if ( error ) {
throw error;
}
client = http2.connect( 'https://localhost:7331', {
'ca': readFileSync( resolve( __dirname, 'examples', 'localhost-cert.pem' ) )
});
req = client.request({
':path': '/beep/boop'
});
req.on( 'response', onResponse );
req.end();
function onResponse() {
console.log( 'Success!' );
client.close();
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',
'allowHTTP1': true,
'cert': readFileSync( resolve( __dirname, 'examples', 'localhost-cert.pem' ) ),
'key': readFileSync( resolve( __dirname, 'examples', 'localhost-privkey.pem' ) )
};
// Create a function for creating an HTTP/2 server...
var http2Server = http2ServerFactory( opts, onRequest );
// Create a server:
http2Server( 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-http2-secure-server.svg
[npm-url]: https://npmjs.org/package/@stdlib/net-http2-secure-server
[test-image]: https://github.com/stdlib-js/net-http2-secure-server/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/net-http2-secure-server/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/net-http2-secure-server/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/net-http2-secure-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-http2-secure-server/tree/deno
[deno-readme]: https://github.com/stdlib-js/net-http2-secure-server/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/net-http2-secure-server/tree/umd
[umd-readme]: https://github.com/stdlib-js/net-http2-secure-server/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/net-http2-secure-server/tree/esm
[esm-readme]: https://github.com/stdlib-js/net-http2-secure-server/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/net-http2-secure-server/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/net-http2-secure-server/main/LICENSE
[nodejs-http2]: https://nodejs.org/api/http2.html
[nodejs-http2-create-secure-server]: https://nodejs.org/api/http2.html#http2createsecureserveroptions-onrequesthandler