Variable createMiddlewareConst

Type Declaration

• • <
        TReq extends IncomingMessage = IncomingMessage,
        TRes extends
            ServerResponse<IncomingMessage> = ServerResponse<IncomingMessage>,
        TNext = (err?: any) => void,
    >(
        options: Options<TReq, TRes>,
    ): RequestHandler<TReq, TRes, TNext>

  • Create proxy middleware for Express-like servers. (list of servers with examples)

    Type Parameters

    • TReq extends IncomingMessage = IncomingMessage
    • TRes extends ServerResponse<IncomingMessage> = ServerResponse<IncomingMessage>
    • TNext = (err?: any) => void

    Parameters

    • options: Options<TReq, TRes>

    Returns RequestHandler<TReq, TRes, TNext>

    Example: Basic proxy to a single target.

    import { createProxyMiddleware } from 'http-proxy-middleware';
    
    const proxy = createProxyMiddleware({
      target: 'http://www.example.org',
      changeOrigin: true,
    });
    Copy

    Example: Proxy only matching paths and rewrite the forwarded path.

    import { createProxyMiddleware } from 'http-proxy-middleware';
    
    const proxy = createProxyMiddleware({
      target: 'http://localhost:3000',
      pathFilter: '/api',
      pathRewrite: {
        '^/api/': '/',
      },
    });
    Copy

    Example: Native path rewrite by mounting at a route (alternative to `pathRewrite`).

    import express from 'express';
    import { createProxyMiddleware } from 'http-proxy-middleware';
    
    const app = express();
    app.use(
      '/users',
      createProxyMiddleware({
        target: 'http://jsonplaceholder.typicode.com/users',
        changeOrigin: true,
      }),
    );
    Copy

    Example: Use framework-specific request/response types (Express).

    import type { Request, Response } from 'express';
    import { createProxyMiddleware } from 'http-proxy-middleware';
    
    const proxy = createProxyMiddleware<Request, Response>({
      target: 'http://www.example.org/api',
      changeOrigin: true,
    });
    Copy

    Example: Intercept and modify a proxied response body.

    import { createProxyMiddleware, responseInterceptor } from 'http-proxy-middleware';
    
    const proxy = createProxyMiddleware({
      target: 'http://www.example.org',
      selfHandleResponse: true,
      on: {
        proxyRes: responseInterceptor(async (responseBuffer) => {
          const response = responseBuffer.toString('utf8');
          return response.replace('Hello', 'Goodbye');
        }),
      },
    });
    Copy

    See

    • https://github.com/chimurai/http-proxy-middleware/
    • https://github.com/chimurai/http-proxy-middleware/#basic-usage
    • https://github.com/chimurai/http-proxy-middleware/#intercept-and-manipulate-responses
    • https://github.com/chimurai/http-proxy-middleware/blob/master/recipes/servers.md
    • https://github.com/chimurai/http-proxy-middleware/blob/master/recipes/pathFilter.md
    • https://github.com/chimurai/http-proxy-middleware/blob/master/recipes/pathRewrite.md
    • https://github.com/chimurai/http-proxy-middleware/blob/master/recipes/response-interceptor.md