Registry / http-networking / middleware-proxy

middleware-proxy

library2.0.5jsnpmunverified

middleware-proxy is a connect-compliant HTTP middleware designed for transparently redirecting incoming requests, primarily useful in development environments where a frontend served by Node.js needs to proxy API calls to a separate backend server. It simplifies integrated project development by allowing developers to access static assets through a local Node server while redirecting RESTful API calls to an external backend. The current stable version is 2.0.5, with recent releases focusing on bug fixes like handling HTTPS and URL parsing edge cases. The package provides a flexible API that supports regular expressions for URL matching and offers an optional feature to strip URL prefixes before forwarding requests, making it suitable for managing API gateway differences between development and production setups.

http-networking web-framework

npm install middleware-proxy

github ↗package ↗

INSTALL

IMPORT

SIG · MIDDLEWARE-PROXY

middleware-proxy

http-networkingjavascriptv2.0.5

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

proxy

✓ const proxy = require('middleware-proxy');

✗ import proxy from 'middleware-proxy';

This package is a CommonJS module. Direct ESM 'import' syntax is not supported and will result in a runtime error. Use 'require()' or a build tool configured for CJS interop.

Demonstrates how to integrate middleware-proxy with an Express application to redirect requests starting with '/service' to a backend server.

const express = require('express'); const app = express(); const http = require('http'); const proxy = require('middleware-proxy'); // Basic Express setup app.set('port', process.env.PORT || 3000); app.use(express.static(__dirname + '/app')); // Serve static files from './app' // Proxy requests starting with '/service' to http://localhost:8080 app.use(proxy('/service', 'http://localhost:8080')); http.createServer(app).listen(app.get('port'), function() { console.log(`Express server listening on port ${app.get('port')}`); });

Debug

Known issues

breakingMajor refactor in v2.0.1 changed the return signature of the main export. Prior to v2.0.1, 'middleware-proxy' returned a function that *created* the middleware. Since v2.0.1, it directly returns the middleware function itself.

fix

Update usage from `app.use(function() { return proxy(...) })` to `app.use(proxy(...))` directly.

affects: <2.0.1

Errors

Common errors & fixes

Error: Cannot find module 'middleware-proxy'

The package has not been installed in your project.

fix

Run `npm install middleware-proxy` or `yarn add middleware-proxy`.

TypeError: proxy is not a function

This error often occurs when attempting to use ESM `import` syntax with a CommonJS module, or incorrect usage after the v2.0.1 refactor (e.g., trying to call `proxy` twice to get the middleware).

fix

Ensure you are using `const proxy = require('middleware-proxy');` for CommonJS. If upgrading from `<v2.0.1`, ensure you are now using `app.use(proxy(...))` directly without an outer function wrapper.

Requests are not being proxied as expected, or are resulting in 404s/incorrect data.

Incorrect 'matcher' string or regular expression, incorrect 'server' URL, or 'path_to_strip' misconfiguration.

fix

Double-check the 'matcher' argument to ensure it correctly identifies the desired URLs (e.g., `/api/v1` for `http://localhost:8080/api/v1`). Verify the 'server' URL is accurate and accessible. Ensure 'path_to_strip' correctly removes the desired prefix without altering the base path incorrectly (e.g., stripping `/api` from `/api/posts` to become `/posts`).

Upgrade

Version history

2.0.5latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/probablyup/middleware-proxy ↗

packagehttps://www.npmjs.com/package/middleware-proxy ↗