@types/http-proxy - npm Package Compare versions

Comparing version 1.17.5 to 1.17.6

http-proxy/index.d.ts

@@ -20,285 +20,208 @@ // Type definitions for node-http-proxy 1.17
 
-type ProxyTarget = ProxyTargetUrl | ProxyTargetDetailed;
-
-type ProxyTargetUrl = string | Partial<url.Url>;
-
 interface ProxyTargetDetailed {
-  host: string;
-  port: number;
-  protocol?: string;
-  hostname?: string;
-  socketPath?: string;
-  key?: string;
-  passphrase?: string;
-  pfx?: Buffer | string;
-  cert?: string;
-  ca?: string;
-  ciphers?: string;
-  secureProtocol?: string;
+    host: string;
+    port: number;
+    protocol?: string;
+    hostname?: string;
+    socketPath?: string;
+    key?: string;
+    passphrase?: string;
+    pfx?: Buffer | string;
+    cert?: string;
+    ca?: string;
+    ciphers?: string;
+    secureProtocol?: string;
 }
 
-type ErrorCallback = (
-  err: Error,
-  req: http.IncomingMessage,
-  res: http.ServerResponse,
-  target?: ProxyTargetUrl
-) => void;
-
 declare class Server extends events.EventEmitter {
-  /**
-   * Creates the proxy server with specified options.
-   * @param options - Config object passed to the proxy
-   */
-  constructor(options?: Server.ServerOptions);
+    /**
+     * 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 req - Client request.
-   * @param res - Client response.
-   * @param options - Additionnal options.
-   */
-  web(
-    req: http.IncomingMessage,
-    res: http.ServerResponse,
-    options?: Server.ServerOptions,
-    callback?: ErrorCallback
-  ): void;
+    /**
+     * Used for proxying regular HTTP(S) requests
+     * @param req - Client request.
+     * @param res - Client response.
+     * @param options - Additionnal options.
+     */
+    web(
+        req: http.IncomingMessage,
+        res: http.ServerResponse,
+        options?: Server.ServerOptions,
+        callback?: Server.ErrorCallback,
+    ): void;
 
-  /**
-   * Used for proxying regular HTTP(S) requests
-   * @param req - Client request.
-   * @param socket - Client socket.
-   * @param head - Client head.
-   * @param options - Additionnal options.
-   */
-  ws(
-    req: http.IncomingMessage,
-    socket: any,
-    head: any,
-    options?: Server.ServerOptions,
-    callback?: ErrorCallback
-  ): void;
+    /**
+     * Used for proxying regular HTTP(S) requests
+     * @param req - Client request.
+     * @param socket - Client socket.
+     * @param head - Client head.
+     * @param options - Additionnal options.
+     */
+    ws(
+        req: http.IncomingMessage,
+        socket: any,
+        head: any,
+        options?: Server.ServerOptions,
+        callback?: Server.ErrorCallback,
+    ): void;
 
-  /**
-   * A function that wraps the object in a webserver, for your convenience
-   * @param port - Port to listen on
-   */
-  listen(port: number): Server;
+    /**
+     * A function that wraps the object in a webserver, for your convenience
+     * @param port - Port to listen on
+     */
+    listen(port: number): Server;
 
-  /**
-   * A function that closes the inner webserver and stops listening on given port
-   */
-  close(callback?: () => void): void;
+    /**
+     * A function that closes the inner webserver and stops listening on given port
+     */
+    close(callback?: () => void): void;
 
-  /**
-   * Creates the proxy server with specified options.
-   * @param options Config object passed to the proxy
-   * @returns Proxy object with handlers for `ws` and `web` requests
-   */
-  static createProxyServer(options?: Server.ServerOptions): Server;
+    /**
+     * Creates the proxy server with specified options.
+     * @param options Config object passed to the proxy
+     * @returns Proxy object with handlers for `ws` and `web` requests
+     */
+    static createProxyServer(options?: Server.ServerOptions): Server;
 
-  /**
-   * Creates the proxy server with specified options.
-   * @param options Config object passed to the proxy
-   * @returns Proxy object with handlers for `ws` and `web` requests
-   */
-  static createServer(options?: Server.ServerOptions): Server;
+    /**
+     * Creates the proxy server with specified options.
+     * @param options Config object passed to the proxy
+     * @returns Proxy object with handlers for `ws` and `web` requests
+     */
+    static createServer(options?: Server.ServerOptions): Server;
 
-  /**
-   * Creates the proxy server with specified options.
-   * @param options Config object passed to the proxy
-   * @returns Proxy object with handlers for `ws` and `web` requests
-   */
-  static createProxy(options?: Server.ServerOptions): Server;
+    /**
+     * Creates the proxy server with specified options.
+     * @param options Config object passed to the proxy
+     * @returns Proxy object with handlers for `ws` and `web` requests
+     */
+    static createProxy(options?: Server.ServerOptions): Server;
 
-  addListener(event: string, listener: () => void): this;
-  on(event: string, listener: () => void): this;
-  on(event: "error", listener: ErrorCallback): this;
-  on(
-    event: "start",
-    listener: (
-      req: http.IncomingMessage,
-      res: http.ServerResponse,
-      target: ProxyTargetUrl
-    ) => void
-  ): this;
-  on(
-    event: "proxyReq",
-    listener: (
-      proxyReq: http.ClientRequest,
-      req: http.IncomingMessage,
-      res: http.ServerResponse,
-      options: Server.ServerOptions
-    ) => void
-  ): this;
-  on(
-    event: "proxyRes",
-    listener: (
-      proxyRes: http.IncomingMessage,
-      req: http.IncomingMessage,
-      res: http.ServerResponse
-    ) => void
-  ): this;
-  on(
-    event: "proxyReqWs",
-    listener: (
-      proxyReq: http.ClientRequest,
-      req: http.IncomingMessage,
-      socket: net.Socket,
-      options: Server.ServerOptions,
-      head: any
-    ) => void
-  ): this;
-  on(
-    event: "econnreset",
-    listener: (
-      err: Error,
-      req: http.IncomingMessage,
-      res: http.ServerResponse,
-      target: ProxyTargetUrl
-    ) => void
-  ): this;
-  on(
-    event: "end",
-    listener: (
-      req: http.IncomingMessage,
-      res: http.ServerResponse,
-      proxyRes: http.IncomingMessage
-    ) => void
-  ): this;
-  on(
-    event: "close",
-    listener: (
-      proxyRes: http.IncomingMessage,
-      proxySocket: net.Socket,
-      proxyHead: any
-    ) => void
-  ): this;
+    addListener(event: string, listener: () => void): this;
+    on(event: string, listener: () => void): this;
+    on(event: "error", listener: Server.ErrorCallback): this;
+    on(event: "start", listener: Server.StartCallback): this;
+    on(event: "proxyReq", listener: Server.ProxyReqCallback): this;
+    on(event: "proxyRes", listener: Server.ProxyResCallback): this;
+    on(event: "proxyReqWs", listener: Server.ProxyReqWsCallback): this;
+    on(event: "econnreset", listener: Server.EconnresetCallback): this;
+    on(event: "end", listener: Server.EndCallback): this;
+    on(event: "open", listener: Server.OpenCallback): this;
+    on(event: "close", listener: Server.CloseCallback): this;
 
-  once(event: string, listener: () => void): this;
-  once(event: "error", listener: ErrorCallback): this;
-  once(
-      event: "start",
-      listener: (
-          req: http.IncomingMessage,
-          res: http.ServerResponse,
-          target: ProxyTargetUrl
-      ) => void
-  ): this;
-  once(
-      event: "proxyReq",
-      listener: (
-          proxyReq: http.ClientRequest,
-          req: http.IncomingMessage,
-          res: http.ServerResponse,
-          options: Server.ServerOptions
-      ) => void
-  ): this;
-  once(
-      event: "proxyRes",
-      listener: (
-          proxyRes: http.IncomingMessage,
-          req: http.IncomingMessage,
-          res: http.ServerResponse
-      ) => void
-  ): this;
-  once(
-      event: "proxyReqWs",
-      listener: (
-          proxyReq: http.ClientRequest,
-          req: http.IncomingMessage,
-          socket: net.Socket,
-          options: Server.ServerOptions,
-          head: any
-      ) => void
-  ): this;
-  once(
-      event: "econnreset",
-      listener: (
-          err: Error,
-          req: http.IncomingMessage,
-          res: http.ServerResponse,
-          target: ProxyTargetUrl
-      ) => void
-  ): this;
-  once(
-      event: "end",
-      listener: (
-          req: http.IncomingMessage,
-          res: http.ServerResponse,
-          proxyRes: http.IncomingMessage
-      ) => void
-  ): this;
-  once(
-      event: "close",
-      listener: (
-          proxyRes: http.IncomingMessage,
-          proxySocket: net.Socket,
-          proxyHead: any
-      ) => void
-  ): this;
-  removeListener(event: string, listener: () => void): this;
-  removeAllListeners(event?: string): this;
-  getMaxListeners(): number;
-  setMaxListeners(n: number): this;
-  listeners(event: string): Array<() => void>;
-  emit(event: string, ...args: any[]): boolean;
-  listenerCount(type: string): number;
+    once(event: string, listener: () => void): this;
+    once(event: "error", listener: Server.ErrorCallback): this;
+    once(event: "start", listener: Server.StartCallback): this;
+    once(event: "proxyReq", listener: Server.ProxyReqCallback): this;
+    once(event: "proxyRes", listener: Server.ProxyResCallback): this;
+    once(event: "proxyReqWs", listener: Server.ProxyReqWsCallback): this;
+    once(event: "econnreset", listener: Server.EconnresetCallback): this;
+    once(event: "end", listener: Server.EndCallback): this;
+    once(event: "open", listener: Server.OpenCallback): this;
+    once(event: "close", listener: Server.CloseCallback): this;
+    removeListener(event: string, listener: () => void): this;
+    removeAllListeners(event?: string): this;
+    getMaxListeners(): number;
+    setMaxListeners(n: number): this;
+    listeners(event: string): Array<() => void>;
+    emit(event: string, ...args: any[]): boolean;
+    listenerCount(type: string): number;
 }
 
 declare namespace Server {
-  interface ServerOptions {
-    /** URL string to be parsed with the url module. */
-    target?: ProxyTarget;
-    /** URL string to be parsed with the url module. */
-    forward?: ProxyTargetUrl;
-    /** Object to be passed to http(s).request. */
-    agent?: any;
-    /** Object to be passed to https.createServer(). */
-    ssl?: any;
-    /** If you want to proxy websockets. */
-    ws?: boolean;
-    /** Adds x- forward headers. */
-    xfwd?: boolean;
-    /** Verify SSL certificate. */
-    secure?: boolean;
-    /** Explicitly specify if we are proxying to another proxy. */
-    toProxy?: boolean;
-    /** Specify whether you want to prepend the target's path to the proxy path. */
-    prependPath?: boolean;
-    /** Specify whether you want to ignore the proxy path of the incoming request. */
-    ignorePath?: boolean;
-    /** Local interface string to bind for outgoing connections. */
-    localAddress?: string;
-    /** Changes the origin of the host header to the target URL. */
-    changeOrigin?: boolean;
-    /** specify whether you want to keep letter case of response header key */
-    preserveHeaderKeyCase?: boolean;
-    /** Basic authentication i.e. 'user:password' to compute an Authorization header. */
-    auth?: string;
-    /** Rewrites the location hostname on (301 / 302 / 307 / 308) redirects, Default: null. */
-    hostRewrite?: string;
-    /** Rewrites the location host/ port on (301 / 302 / 307 / 308) redirects based on requested host/ port.Default: false. */
-    autoRewrite?: boolean;
-    /** Rewrites the location protocol on (301 / 302 / 307 / 308) redirects to 'http' or 'https'.Default: null. */
-    protocolRewrite?: string;
-    /** rewrites domain of set-cookie headers. */
-    cookieDomainRewrite?: false | string | {[oldDomain: string]: string};
-    /** rewrites path of set-cookie headers. Default: false */
-    cookiePathRewrite?: false | string | {[oldPath: string]: string};
-    /** object with extra headers to be added to target requests. */
-    headers?: {[header: string]: string};
-    /** Timeout (in milliseconds) when proxy receives no response from target. Default: 120000 (2 minutes) */
-    proxyTimeout?: number;
-    /** Timeout (in milliseconds) for incoming requests */
-    timeout?: number;
-    /** Specify whether you want to follow redirects. Default: false */
-    followRedirects?: boolean;
-    /** If set to true, none of the webOutgoing passes are called and it's your responsibility to appropriately return the response by listening and acting on the proxyRes event */
-    selfHandleResponse?: boolean;
-    /** Buffer */
-    buffer?: stream.Stream;
-  }
+    type ProxyTarget = ProxyTargetUrl | ProxyTargetDetailed;
+    type ProxyTargetUrl = string | Partial<url.Url>;
+
+    interface ServerOptions {
+        /** URL string to be parsed with the url module. */
+        target?: ProxyTarget;
+        /** URL string to be parsed with the url module. */
+        forward?: ProxyTargetUrl;
+        /** Object to be passed to http(s).request. */
+        agent?: any;
+        /** Object to be passed to https.createServer(). */
+        ssl?: any;
+        /** If you want to proxy websockets. */
+        ws?: boolean;
+        /** Adds x- forward headers. */
+        xfwd?: boolean;
+        /** Verify SSL certificate. */
+        secure?: boolean;
+        /** Explicitly specify if we are proxying to another proxy. */
+        toProxy?: boolean;
+        /** Specify whether you want to prepend the target's path to the proxy path. */
+        prependPath?: boolean;
+        /** Specify whether you want to ignore the proxy path of the incoming request. */
+        ignorePath?: boolean;
+        /** Local interface string to bind for outgoing connections. */
+        localAddress?: string;
+        /** Changes the origin of the host header to the target URL. */
+        changeOrigin?: boolean;
+        /** specify whether you want to keep letter case of response header key */
+        preserveHeaderKeyCase?: boolean;
+        /** Basic authentication i.e. 'user:password' to compute an Authorization header. */
+        auth?: string;
+        /** Rewrites the location hostname on (301 / 302 / 307 / 308) redirects, Default: null. */
+        hostRewrite?: string;
+        /** Rewrites the location host/ port on (301 / 302 / 307 / 308) redirects based on requested host/ port.Default: false. */
+        autoRewrite?: boolean;
+        /** Rewrites the location protocol on (301 / 302 / 307 / 308) redirects to 'http' or 'https'.Default: null. */
+        protocolRewrite?: string;
+        /** rewrites domain of set-cookie headers. */
+        cookieDomainRewrite?: false | string | { [oldDomain: string]: string };
+        /** rewrites path of set-cookie headers. Default: false */
+        cookiePathRewrite?: false | string | { [oldPath: string]: string };
+        /** object with extra headers to be added to target requests. */
+        headers?: { [header: string]: string };
+        /** Timeout (in milliseconds) when proxy receives no response from target. Default: 120000 (2 minutes) */
+        proxyTimeout?: number;
+        /** Timeout (in milliseconds) for incoming requests */
+        timeout?: number;
+        /** Specify whether you want to follow redirects. Default: false */
+        followRedirects?: boolean;
+        /** If set to true, none of the webOutgoing passes are called and it's your responsibility to appropriately return the response by listening and acting on the proxyRes event */
+        selfHandleResponse?: boolean;
+        /** Buffer */
+        buffer?: stream.Stream;
+    }
+
+    type StartCallback = (req: http.IncomingMessage, res: http.ServerResponse, target: ProxyTargetUrl) => void;
+    type ProxyReqCallback = (
+        proxyReq: http.ClientRequest,
+        req: http.IncomingMessage,
+        res: http.ServerResponse,
+        options: ServerOptions,
+    ) => void;
+    type ProxyResCallback = (
+        proxyRes: http.IncomingMessage,
+        req: http.IncomingMessage,
+        res: http.ServerResponse,
+    ) => void;
+    type ProxyReqWsCallback = (
+        proxyReq: http.ClientRequest,
+        req: http.IncomingMessage,
+        socket: net.Socket,
+        options: ServerOptions,
+        head: any,
+    ) => void;
+    type EconnresetCallback = (
+        err: Error,
+        req: http.IncomingMessage,
+        res: http.ServerResponse,
+        target: ProxyTargetUrl,
+    ) => void;
+    type EndCallback = (req: http.IncomingMessage, res: http.ServerResponse, proxyRes: http.IncomingMessage) => void;
+    type OpenCallback = (proxySocket: net.Socket) => void;
+    type CloseCallback = (proxyRes: http.IncomingMessage, proxySocket: net.Socket, proxyHead: any) => void;
+    type ErrorCallback = (
+        err: Error,
+        req: http.IncomingMessage,
+        res: http.ServerResponse,
+        target?: ProxyTargetUrl,
+    ) => void;
 }
 
 export = Server;

http-proxy/package.json

 {
     "name": "@types/http-proxy",
-    "version": "1.17.5",
+    "version": "1.17.6",
     "description": "TypeScript definitions for node-http-proxy",
@@ -44,4 +44,4 @@ "license": "MIT",
     },
-    "typesPublisherContentHash": "8d9fbccf96307a62df1824497003b5959e1cb54dcbb44b22b6287831fce38541",
-    "typeScriptVersion": "3.4"
+    "typesPublisherContentHash": "72f2f54abebf2429e43f9c47a929d81020d85c413aacb2ed0e997c0129320f88",
+    "typeScriptVersion": "3.5"
 }

http-proxy/README.md

@@ -11,3 +11,3 @@ # Installation
 ### Additional Details
- * Last updated: Fri, 15 Jan 2021 16:57:14 GMT
+ * Last updated: Fri, 14 May 2021 23:01:25 GMT
  * Dependencies: [@types/node](https://npmjs.com/package/@types/node)
@@ -14,0 +14,0 @@ * Global values: none

No alert changes

Worsened metrics

Total package byte prevSize

12309

decreased by-0.55%

Lines of code

209

decreased by-26.67%

No dependency changes