Data

Tools

Indexes

Applications

Experiments

Open Source Science

@stdlib/net-http-server

HTTP server.

https://github.com/stdlib-js/net-http-server

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.5%) to scientific vocabulary

Keywords

create http javascript net network networking node node-js nodejs server stdlib
Last synced: 4 months ago · JSON representation ·

Repository

HTTP server.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 3
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
create http javascript net network networking node node-js nodejs server stdlib
Created over 4 years ago · Last pushed 5 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

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 Server

NPM version Build Status Coverage Status <!-- dependencies -->

HTTP server.

## Installation ```bash npm install @stdlib/net-http-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 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-2025. The Stdlib [Authors][stdlib-authors].

Owner

  • Name: stdlib
  • Login: stdlib-js
  • Kind: organization

Standard library for JavaScript.

Citation (CITATION.cff) 

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total
  • Push event: 35
Last Year
  • Push event: 35

Issues and Pull Requests

Last synced: 5 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • npm 20 last-month
  • Total dependent packages: 4
  • Total dependent repositories: 2
  • Total versions: 12
  • Total maintainers: 4
npmjs.org: @stdlib/net-http-server

HTTP server.

  • Homepage: https://stdlib.io
  • License: Apache-2.0
  • Latest release: 0.2.2
    published over 1 year ago
  • Versions: 12
  • Dependent Packages: 4
  • Dependent Repositories: 2
  • Downloads: 20 Last month
Rankings
Dependent packages count: 4.5%
Dependent repos count: 7.6%
Average: 12.4%
Forks count: 15.4%
Stargazers count: 16.7%
Downloads: 17.5%
Maintainers (4)
planeshifter rreusser stdlib-bot kgryte
Funding
  • type: opencollective
  • url: https://opencollective.com/stdlib
Last synced: 5 months ago

Dependencies

package.json npm
  • @stdlib/utils-keys ^0.0.x development
  • @stdlib/utils-noop ^0.0.x development
  • istanbul ^0.4.1 development
  • tap-spec 5.x.x development
  • tape git+https://github.com/kgryte/tape.git#fix/globby development
  • @stdlib/assert-has-own-property ^0.0.x
  • @stdlib/assert-is-function ^0.0.x
  • @stdlib/assert-is-nonnegative-integer ^0.0.x
  • @stdlib/assert-is-plain-object ^0.0.x
  • @stdlib/assert-is-string ^0.0.x
  • @stdlib/string-format ^0.0.x
  • debug ^2.6.9
.github/workflows/cancel.yml actions
  • styfle/cancel-workflow-action 0.11.0 composite
.github/workflows/close_pull_requests.yml actions
  • superbrothers/close-pull-request v3 composite
.github/workflows/examples.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/npm_downloads.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • actions/upload-artifact v3 composite
  • distributhor/workflow-webhook v3 composite
.github/workflows/productionize.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • stdlib-js/bundle-action main composite
  • stdlib-js/transform-errors-action main composite
.github/workflows/publish.yml actions
  • JS-DevTools/npm-publish v1 composite
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • styfle/cancel-workflow-action 0.11.0 composite
.github/workflows/test.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/test_bundles.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • denoland/setup-deno v1 composite
.github/workflows/test_coverage.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • codecov/codecov-action v3 composite
  • distributhor/workflow-webhook v3 composite
.github/workflows/test_install.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite