TypeScript definitions for node-http-proxy. 

types

@types/http-proxy

TypeScript definitions for node-http-proxy

// Type definitions for node-http-proxy 1.17

// Project: https://github.com/nodejitsu/node-http-proxy

// Definitions by: Maxime LUCE <https://github.com/SomaticIT>

//                 Florian Oellerich <https://github.com/Raigen>

//                 Daniel Schmidt <https://github.com/DanielMSchmidt>

//                 Jordan Abreu <https://github.com/jabreu610>

//                 Samuel Bodin <https://github.com/bodinsamuel>

// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

declare class Server<TIncomingMessage = http.IncomingMessage, TServerResponse = http.ServerResponse> extends events.EventEmitter {

     * Creates the proxy server with specified options.

     * @param options - Config object passed to the proxy

    constructor(options?: Server.ServerOptions);

     * Used for proxying regular HTTP(S) requests

     * @param options - Additional options.

     * @param options - Additionnal options.

     * A function that wraps the object in a webserver, for your convenience

     * @param hostname - The hostname to listen on

    listen(port: number): Server<TIncomingMessage, TServerResponse>;

    listen(port: number, hostname?: string): Server<TIncomingMessage, TServerResponse>;

     * A function that closes the inner webserver and stops listening on given port

     * @param options Config object passed to the proxy

     * @returns Proxy object with handlers for `ws` and `web` requests

    // tslint:disable:no-unnecessary-generics

    static createProxyServer<TIncomingMessage = http.IncomingMessage, TServerResponse = http.ServerResponse>(options?: Server.ServerOptions): Server<TIncomingMessage, TServerResponse>;

    static createServer<TIncomingMessage = http.IncomingMessage, TServerResponse = http.ServerResponse>(options?: Server.ServerOptions): Server<TIncomingMessage, TServerResponse>;

    static createProxy<TIncomingMessage = http.IncomingMessage, TServerResponse = http.ServerResponse>(options?: Server.ServerOptions): Server<TIncomingMessage, TServerResponse>;

    addListener(event: string, listener: () => void): this;

    on(event: string, listener: () => void): this;

    on(event: "error", listener: Server.ErrorCallback<Error, TIncomingMessage, TServerResponse>): this;

    on(event: "start", listener: Server.StartCallback<TIncomingMessage, TServerResponse>): this;

    on(event: "proxyReq", listener: Server.ProxyReqCallback<http.ClientRequest, TIncomingMessage, TServerResponse>): this;

    on(event: "proxyRes", listener: Server.ProxyResCallback<TIncomingMessage, TServerResponse>): this;

    on(event: "proxyReqWs", listener: Server.ProxyReqWsCallback<http.ClientRequest, TIncomingMessage>): this;

    on(event: "econnreset", listener: Server.EconnresetCallback<Error, TIncomingMessage, TServerResponse>): this;

    on(event: "end", listener: Server.EndCallback<TIncomingMessage, TServerResponse>): this;

    on(event: "open", listener: Server.OpenCallback): this;

    on(event: "close", listener: Server.CloseCallback<TIncomingMessage>): this;

    once(event: string, listener: () => void): this;

    once(event: "error", listener: Server.ErrorCallback<Error, TIncomingMessage, TServerResponse>): this;

    once(event: "start", listener: Server.StartCallback<TIncomingMessage, TServerResponse>): this;

    once(event: "proxyReq", listener: Server.ProxyReqCallback<http.ClientRequest, TIncomingMessage, TServerResponse>): this;

    once(event: "proxyRes", listener: Server.ProxyResCallback<TIncomingMessage, TServerResponse>): this;

    once(event: "proxyReqWs", listener: Server.ProxyReqWsCallback<http.ClientRequest, TIncomingMessage>): this;

    once(event: "econnreset", listener: Server.EconnresetCallback<Error, TIncomingMessage, TServerResponse>): this;

    once(event: "end", listener: Server.EndCallback<TIncomingMessage, TServerResponse>): this;

    once(event: "open", listener: Server.OpenCallback): this;

    once(event: "close", listener: Server.CloseCallback<TIncomingMessage>): this;

    removeListener(event: string, listener: () => void): this;

    removeAllListeners(event?: string): this;

    listeners(event: string): Array<() => void>;

    emit(event: string, ...args: any[]): boolean;

    type ProxyTarget = ProxyTargetUrl | ProxyTargetDetailed;

    type ProxyTargetUrl = string | Partial<url.Url>;

        /** URL string to be parsed with the url module. */

        target?: ProxyTarget | undefined;

        forward?: ProxyTargetUrl | undefined;

        /** Object to be passed to http(s).request. */

        /** Object to be passed to https.createServer(). */

        /** If you want to proxy websockets. */

        /** Explicitly specify if we are proxying to another proxy. */

        /** Specify whether you want to prepend the target's path to the proxy path. */

        prependPath?: boolean | undefined;

        /** Specify whether you want to ignore the proxy path of the incoming request. */

        ignorePath?: boolean | undefined;

        /** Local interface string to bind for outgoing connections. */

        localAddress?: string | undefined;

        /** Changes the origin of the host header to the target URL. */

        changeOrigin?: boolean | undefined;

        /** specify whether you want to keep letter case of response header key */

        preserveHeaderKeyCase?: boolean | undefined;

        /** Basic authentication i.e. 'user:password' to compute an Authorization header. */

        /** Rewrites the location hostname on (301 / 302 / 307 / 308) redirects, Default: null. */

        hostRewrite?: string | undefined;

        /** Rewrites the location host/ port on (301 / 302 / 307 / 308) redirects based on requested host/ port.Default: false. */

        autoRewrite?: boolean | undefined;

        /** Rewrites the location protocol on (301 / 302 / 307 / 308) redirects to 'http' or 'https'.Default: null. */

        protocolRewrite?: string | undefined;

        /** rewrites domain of set-cookie headers. */

    "description": "TypeScript definitions for node-http-proxy",

    "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/http-proxy",

            "url": "https://github.com/SomaticIT",

            "githubUsername": "SomaticIT"

            "url": "https://github.com/Raigen",

            "url": "https://github.com/DanielMSchmidt",

            "githubUsername": "DanielMSchmidt"

            "url": "https://github.com/jabreu610",

            "githubUsername": "jabreu610"

            "url": "https://github.com/bodinsamuel",

            "githubUsername": "bodinsamuel"

        "url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git",

    "typesPublisherContentHash": "15640e1828ff9696bca89b4df02ad632eb05d58e80b3b838f9599ae2b3049e2b",

    "typesPublisherContentHash": "09755a617424e003f20520df0294c295f1403b2e76833c83438eb45c953f9e51",

This package contains type definitions for node-http-proxy (https://github.com/nodejitsu/node-http-proxy).

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/http-proxy.

 * Last updated: Wed, 22 Feb 2023 14:02:29 GMT

 * Last updated: Tue, 25 Apr 2023 20:02:48 GMT

 * Dependencies: [@types/node](https://npmjs.com/package/@types/node)

These definitions were written by [Maxime LUCE](https://github.com/SomaticIT), [Florian Oellerich](https://github.com/Raigen), [Daniel Schmidt](https://github.com/DanielMSchmidt), [Jordan Abreu](https://github.com/jabreu610), and [Samuel Bodin](https://github.com/bodinsamuel).

		{
		"name": "@types/http-proxy",
		"version": "1.17.10",
		"version": "1.17.11",
		"description": "TypeScript definitions for node-http-proxy",
		@@ -45,4 +45,4 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/http-proxy",
		},
		"typesPublisherContentHash": "15640e1828ff9696bca89b4df02ad632eb05d58e80b3b838f9599ae2b3049e2b",
		"typeScriptVersion": "4.2"
		"typesPublisherContentHash": "09755a617424e003f20520df0294c295f1403b2e76833c83438eb45c953f9e51",
		"typeScriptVersion": "4.3"
		}

		@@ -73,4 +73,5 @@ // Type definitions for node-http-proxy 1.17
		* @param port - Port to listen on
		* @param hostname - The hostname to listen on
		*/
		listen(port: number): Server<TIncomingMessage, TServerResponse>;
		listen(port: number, hostname?: string): Server<TIncomingMessage, TServerResponse>;

		@@ -77,0 +78,0 @@ /**

		@@ -11,3 +11,3 @@ # Installation
		### Additional Details
		* Last updated: Wed, 22 Feb 2023 14:02:29 GMT
		* Last updated: Tue, 25 Apr 2023 20:02:48 GMT
		* Dependencies: [@types/node](https://npmjs.com/package/@types/node)
		@@ -14,0 +14,0 @@ * Global values: none

Improved metrics