http-proxy-middleware

property logLevel

logLevel?: any;

• Example 1

  {
   logger: console
  }

  Deprecated

  Use logger instead.

property logProvider

logProvider?: any;

• Example 1

  {
   logger: console
  }

  Deprecated

  Use logger instead.

property onClose

onClose?: (...args: any[]) => void;

• Example 1

  {
    on: {
     close: () => {}
  }

  Deprecated

  Use on.close instead.

property onError

onError?: (...args: any[]) => void;

• Example 1

  {
    on: {
     error: () => {}
  }

  Deprecated

  Use on.error instead.

property onOpen

onOpen?: (...args: any[]) => void;

• Example 1

  {
    on: {
     open: () => {}
  }

  Deprecated

  Use on.open instead.

property onProxyReq

onProxyReq?: (...args: any[]) => void;

• Example 1

  {
    on: {
     proxyReq: () => {}
  }

  Deprecated

  Use on.proxyReq instead.

property onProxyReqWs

onProxyReqWs?: (...args: any[]) => void;

• Example 1

  {
    on: {
     proxyReqWs: () => {}
  }

  Deprecated

  Use on.proxyReqWs instead.

property onProxyRes

onProxyRes?: (...args: any[]) => void;

• Example 1

  {
    on: {
     proxyRes: () => {}
  }

  Deprecated

  Use on.proxyRes instead.

property ejectPlugins

ejectPlugins?: boolean;

• Eject pre-configured plugins. NOTE: register your own error handlers to prevent server from crashing.

  https://github.com/chimurai/http-proxy-middleware#ejectplugins-boolean-default-false v3.0.0

property logger

logger?: Logger | any;

• Log information from http-proxy-middleware

  Example 1

  createProxyMiddleware({
   logger: console
  });

  https://github.com/chimurai/http-proxy-middleware/blob/master/recipes/logger.md v3.0.0

property on

on?: OnProxyEvent<TReq, TRes>;

• Listen to http-proxy events

  Example 1

  createProxyMiddleware({
    on: {
      error: (error, req, res, target) => {
        console.error(error);
      }
    }
  });

  https://github.com/chimurai/http-proxy-middleware/blob/master/recipes/proxy-events.md v3.0.0

  See Also

  • OnProxyEvent for available events

property pathFilter

pathFilter?: Filter<TReq>;

• Narrow down requests to proxy or not. Filter on which is relative to the proxy's "mounting" point in the server. Or use the object for more complex filtering. https://github.com/chimurai/http-proxy-middleware/blob/master/recipes/pathFilter.md v3.0.0

property pathRewrite

pathRewrite?:
    | {
          [regexp: string]: string;
      }
    | ((path: string, req: TReq) => string | undefined)
    | ((path: string, req: TReq) => Promise<string>);

• Modify request paths before requests are send to the target.

  Example 1

  createProxyMiddleware({
    pathRewrite: {
      '^/api/old-path': '/api/new-path', // rewrite path
    }
  });

  https://github.com/chimurai/http-proxy-middleware/blob/master/recipes/pathRewrite.md

property plugins

plugins?: Plugin<TReq, TRes>[];

• Access the internal http-proxy server instance to customize behavior

  Example 1

  createProxyMiddleware({
    plugins: [(proxyServer, options) => {
      proxyServer.on('error', (error, req, res) => {
        console.error(error);
      });
    }]
  });

  https://github.com/chimurai/http-proxy-middleware#plugins-array v3.0.0

property router

router?:
    | {
          [hostOrPath: string]: httpProxy.ServerOptions['target'];
      }
    | ((req: TReq) => httpProxy.ServerOptions['target'])
    | ((req: TReq) => Promise<httpProxy.ServerOptions['target']>);

• Dynamically set the .

  Example 1

  createProxyMiddleware({
    router: async (req) => {
      return 'http://127:0.0.1:3000';
    }
  });

  https://github.com/chimurai/http-proxy-middleware/blob/master/recipes/router.md

property upgrade

upgrade: (req: http.IncomingMessage, socket: net.Socket, head: Buffer) => void;

call signature

(req: TReq, res: TRes, next?: TNext): Promise<void>;