proximate v1.0.0

proximate

Support

Basic usage

Headings

#1 Port of server #2 The domain or IP we should forward this request to #3 The network port this request should be forwarded on

const { httpProxy } = require('.')
const http = require('http')

http.createServer().listen(/*<#1>*/ 8080 ).on('connection', (client) => {
    console.log("Proxying ",client.address())
    httpProxy(client,/*<#2>*/ "eu.httpbin.org" ,/*<#3>*/ 80  )
})

Advance usage

You are going to want to extend the base class.

export declare class base {
    /**The underlying proxy function. Returns a function that can be used to kill the connection
     * @param socket The connection that should be forwarded
     * @param handler The function for handling resolving the hostname and port that should be proxied to.
     * Given here as a function to allow for dynamic allocation
    */
    proxy(socket: Duplex | TLSSocket, handler: (host: string) => {
        prxy: string;
        port: number;
    }): Promise<() => void>;
    /**Used to upgrade connections. Mainly for HTTPS to HTTPS communication
     * @param socket The outgoing socket that is used to forward messages from the client
    */
    protected upgrade(socket: Socket): Socket | TLSSocket;
    /**Modifies the underlying header of a sent request
     * @param header The raw header. It is given in this format to keep things speedy.
     * Do note that removing the white spaces around the header is not recommended in the slightest degree.
    */
    protected modHeader(header: string): string;
}

Furthermore, after extending the base class you are going to want to override the upgrade and modHeader functions.

Function: modHeader(header: string): string

The modHeader function allows you to modify the raw header of a proxied request. Do note that adding whitespaces at the end of a request can cause it to fail.

Function: upgrade(socket: Socket): Socket | TLSSocket

This function can be overwritten if you are trying to do HTTPS to HTTPS communication/proxying or need to change something about the proxied port.

WIP

The lib is still seeing development. Hope onto the discord to suggest changes.