https://github.com/watson/reverse-http

A reverse HTTP client
https://github.com/watson/reverse-http

Last synced: 2 months ago
JSON representation

A reverse HTTP client

• Host: GitHub
• URL: https://github.com/watson/reverse-http
• Owner: watson
• License: mit
• Created: 2016-04-11T09:26:12.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-05-18T22:44:41.000Z (over 7 years ago)
• Last Synced: 2024-07-22T06:24:14.896Z (2 months ago)
• Language: JavaScript
• Size: 19.5 KB
• Stars: 42
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# reverse-http

Create a reverse HTTP connection to an HTTP server that supports

[Reverse HTTP](https://tools.ietf.org/html/draft-lentczner-rhttp-00).

[![Build status](https://travis-ci.org/watson/reverse-http.svg?branch=master)](https://travis-ci.org/watson/reverse-http)

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)

## Installation

```

npm install reverse-http --save

```

## Usage

```js

var reverseHttp = require('reverse-http')

var opts = {

  hostname: 'example.com',

  path: '/foo'

}

// Open an HTTP connection to example.com and accept reverse HTTP

// requests back to this machine

reverseHttp(opts, function (req, res) {

  console.log('Incoming request:', req.method, req.url)

  res.writeHead(201, {

    'Content-Type': 'text/plain',

    'Content-Length': 11

  })

  res.end('Hello World')

})

```

## API

### `var server = reverseHttp(options[, onRequest])`

Create a reverse HTTP connection to the HTTP server specificed in

`options`. Returns an instance of `ReverseServer`. The `ReverseServer`

inherits from

[`http.Server`](https://nodejs.org/api/http.html#http_class_http_server)

and as such exposes the same API.

Besides the regular `options` inherited from

[`http.request`](https://nodejs.org/api/http.html#http_http_request_options_callback)

the following special options are also available:

- `tls` - create an https connection (default: `false`)

- `rejectUnauthorized` - if `true`, the server certificate is verified

  (default: `true`)

Note that the HTTP method defaults to `POST`.

The optional `onRequest` callback will be attached as a listener to the

`request` event.

The following headers are added by default to the establishing outgoing

HTTP request:

```http

Upgrade: PTTH/1.0

Connection: Upgrade

Content-Length: 0

```

### `server.destroy()`

Close the server and destroy the socket.

## License

MIT