@stdlib/net-disposable-http-server

Disposable HTTP server.

https://github.com/stdlib-js/net-disposable-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
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.8%) to scientific vocabulary

Keywords

create disposable http javascript net network networking node node-js nodejs once one-time serve server static stdlib temp temporary throwaway
Last synced: 4 months ago · JSON representation ·

Repository

Disposable HTTP server.

Basic Info
Statistics
  • Stars: 2
  • Watchers: 3
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
create disposable http javascript net network networking node node-js nodejs once one-time serve server static stdlib temp temporary throwaway
Created over 4 years ago · Last pushed 4 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!

Disposable HTTP Server

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

Create a disposable HTTP server.

## Installation ```bash npm install @stdlib/net-disposable-http-server ```
## Usage ```javascript var httpServer = require( '@stdlib/net-disposable-http-server' ); ``` #### httpServer( options\[, clbk] ) Creates a disposable HTTP server; i.e., the server closes immediately after serving provided content. ```javascript var opts = { 'html': '', 'javascript': 'console.log( "Boop" );' }; 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. - **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`. To serve HTML content, set the `html` option. Once the content is requested, the server will close. ```javascript var opts = { 'html': '

Beep

' }; httpServer( opts ); ``` To serve JavaScript, set the `javascript` option. If no HTML is provided, an HTML boilerplate is served and the JavaScript is served as `/bundle.js`. Once the content is requested, the server will close. ```javascript var opts = { 'javascript': 'console.log( "Boop" );' }; httpServer( opts ); ``` If HTML and JavaScript are provided, in order for the JavaScript to be served, the HTML content should request the file `/bundle.js`. ```javascript var opts = { 'html': '', 'javascript': 'console.log( "Boop" );' }; httpServer( opts ); ``` To obtain the `server` handle, provide a callback. ```javascript var nextTick = require( '@stdlib/utils-next-tick' ); function onReady( error, server ) { if ( error ) { throw error; } nextTick( close ); function close() { server.close(); } } var opts = { 'html': html, 'javascript': 'console.log( "Boop" );' }; httpServer( opts, onReady ); ```
## Notes - If neither the `html` nor `javascript` option is set, the server serves an HTML boilerplate and then closes.
## Examples ```javascript var join = require( 'path' ).join; var readFileSync = require( '@stdlib/fs-read-file' ).sync; var httpServer = require( '@stdlib/net-disposable-http-server' ); var html = join( __dirname, 'examples', 'fixtures', 'index.html' ); var js = join( __dirname, 'examples', 'fixtures', 'script.js' ); var opts = { 'html': readFileSync( html ), 'javascript': readFileSync( js ), 'port': 7331, 'hostname': 'localhost', 'open': false }; httpServer( opts, clbk ); function clbk( error, server ) { if ( error ) { throw error; } // Give the user a few seconds to open her web browser before closing the server... setTimeout( onTimeout, 5000 ); function onTimeout() { server.close(); } } ```

## CLI
## Installation To use as a general utility, install the CLI package globally ```bash npm install -g @stdlib/net-disposable-http-server-cli ```
### Usage ```text Usage: temp-http-server [options] (--html path | --js path | --stdin type) Options: -h, --help Print this message. -V, --version Print the package version. --html path Serve HTML. --js, --javascript path Serve JavaScript. --stdin type Type of content: html or javascript. -p, --port port Server port. Default: 0. --maxport maxport Max server port. Default: `port`. --hostname hostname Server hostname. --address address Server address. Default: 0.0.0.0. --open Launch a browser once server is ready. ``` The application recognizes the following [environment variables][environment-variable]: - `DEBUG`: enable verbose logging. - `PORT`: server port. - `MAXPORT`: max server port. - `HOSTNAME`: server hostname. - `ADDRESS`: server address.
### Notes - Command-line arguments **always** take precedence over [environment variables][environment-variable]. - If either the `--html` or `--javascript` command-line flag is set, `stdin` is assumed to be of the other type. Accordingly, the `--stdin` flag may be omitted.
### Examples To serve an HTML file, ```bash $ DEBUG=* temp-http-server --html ./examples/fixtures/index.html ... ``` To serve a JavaScript file (and a default HTML boilerplate), ```bash $ DEBUG=* temp-http-server --javascript ./examples/fixtures/script.js ... ``` In addition to file input, the application accepts [standard input][standard-streams]. To pipe HTML, ```bash $ cat ./examples/fixtures/index.html | DEBUG=* temp-http-server --port 7331 --stdin html ... ``` To pipe HTML and load a JavaScript file, ```bash $ cat ./examples/fixtures/index.html | DEBUG=* temp-http-server --port 7331 --javascript ./examples/fixtures/script.js ... ``` To pipe JavaScript (and serve a default HTML boilerplate), ```bash $ cat ./examples/fixtures/script.js | DEBUG=* temp-http-server --address '127.0.0.1' --stdin javascript ... ``` To pipe JavaScript and serve custom HTML content which requests a `/bundle.js` file, ```bash $ cat ./examples/fixtures/script.js | DEBUG=* temp-http-server --html ./examples/fixtures/index.html ... ```

* * * ## 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: 9
Last Year
  • Push event: 9

Committers

Last synced: almost 2 years ago

All Time
  • Total Commits: 56
  • Total Committers: 1
  • Avg Commits per committer: 56.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 16
  • Committers: 1
  • Avg Commits per committer: 16.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
stdlib-bot n****y@s****o 56
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 4 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
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

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

Disposable HTTP server.

  • Homepage: https://stdlib.io
  • License: Apache-2.0
  • Latest release: 0.2.2
    published over 1 year ago
  • Versions: 13
  • Dependent Packages: 2
  • Dependent Repositories: 0
  • Downloads: 11 Last month
Rankings
Dependent packages count: 9.5%
Stargazers count: 16.8%
Forks count: 17.4%
Average: 18.7%
Downloads: 24.3%
Dependent repos count: 25.3%
Funding
  • type: opencollective
  • url: https://opencollective.com/stdlib
Last synced: 4 months ago

Dependencies

package.json npm
  • @stdlib/assert-is-browser ^0.0.x development
  • @stdlib/assert-is-windows ^0.0.x development
  • @stdlib/process-exec-path ^0.0.x development
  • istanbul ^0.4.1 development
  • proxyquire ^2.0.0 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-boolean ^0.0.x
  • @stdlib/assert-is-buffer ^0.0.x
  • @stdlib/assert-is-function ^0.0.x
  • @stdlib/assert-is-plain-object ^0.0.x
  • @stdlib/assert-is-string ^0.0.x
  • @stdlib/buffer-ctor ^0.0.x
  • @stdlib/buffer-from-string ^0.0.x
  • @stdlib/cli-ctor ^0.0.x
  • @stdlib/fs-read-file ^0.0.x
  • @stdlib/net-http-server ^0.0.x
  • @stdlib/process-cwd ^0.0.x
  • @stdlib/process-env ^0.0.x
  • @stdlib/process-read-stdin ^0.0.x
  • @stdlib/string-format ^0.0.x
  • @stdlib/utils-keys ^0.0.x
  • @stdlib/utils-next-tick ^0.0.x
  • @stdlib/utils-noop ^0.0.x
  • @stdlib/utils-open-url ^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/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_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