httprelay-js

JavaScript and TypeScript library for HTTP Relay server. Currently, only proxy communication method is implemented.

Installation

Source code respository.

To use as a JavaScript module:

npm i httprelay

If you are planning to use this library from the local file system (without using webserver) please use the non-module version. JavaScript modules are not loaded due to CORS restrictions. To use as a classic JavaScript library include this in to your HTML:

<script src="https://unpkg.com/httprelay/lib/non-mod/httprelay.js"></script>

it will load most recent library version. Better idea is to reference fixed version:

<script src="https://unpkg.com/[email protected]/lib/non-mod/httprelay.js"></script>

replace 0.0.44 with the version that you are going to use.

Proxy communication method

Proxy communication method lets you use your web browser as a server. There is no need to have a real IP address, this even works behind the firewall, NAT or web proxy server. You can serve dynamic web pages, write your own API endpoints, even serve files. For proxy communication method this library acts as a small framework with these features:

• Handlers (actions) - functions that will be called on HTTP request
• Routes - registered paths that will invoke handler functions
• Assets - images, JS, CSS that will be served to the client
• Templates - minimalistic HTML templates

Examples

• Basic usage
• Interactive page
• File sharing
• REST API
• Assets

Documentation

HTTP Relay JavaScript library documentation