Skip to content

Commit

Permalink
chore(package): v3.0.0 (#947)
Browse files Browse the repository at this point in the history
  • Loading branch information
chimurai committed Apr 1, 2024
1 parent 19a3f00 commit 84bfa46
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 3 deletions.
7 changes: 6 additions & 1 deletion CHANGELOG.md
@@ -1,6 +1,11 @@
# Changelog

## next
## [v3.0.0](https://github.com/chimurai/http-proxy-middleware/releases/tag/v3.0.0)

This release contains some breaking changes.

Please read the V3 discussion <https://github.com/chimurai/http-proxy-middleware/discussions/768>
or follow the [MIGRATION.md](https://github.com/chimurai/http-proxy-middleware/blob/master/MIGRATION.md) guide.

- feat(typescript): type improvements ([#882](https://github.com/chimurai/http-proxy-middleware/pull/882))
- chore(deps): update micromatch to 4.0.5
Expand Down
11 changes: 11 additions & 0 deletions MIGRATION.md
@@ -1,5 +1,6 @@
# Migration guide

- [v3 changes and discussions](#v3-changes-and-discussions)
- [v2 to v3 adapter](#v2-to-v3-adapter)
- [`legacyCreateProxyMiddleware`](#legacycreateproxymiddleware)
- [v3 breaking changes](#v3-breaking-changes)
Expand All @@ -10,12 +11,20 @@
- [Removed `logProvider` and `logLevel` options](#removed-logprovider-and-loglevel-options)
- [Refactored proxy events](#refactored-proxy-events)

## v3 changes and discussions

See list of changes in V3:

<https://github.com/chimurai/http-proxy-middleware/discussions/768>

## v2 to v3 adapter

### `legacyCreateProxyMiddleware`

Use the adapter to use v3 with minimal changes to your v2 implementation.

💡 When you use `legacyCreateProxyMiddleware` it will print out console messages in run-time to guide you on how to migrate legacy configurations.

NOTE: `legacyCreateProxyMiddleware` will be removed in a future version.

```js
Expand Down Expand Up @@ -46,6 +55,8 @@ legacyCreateProxyMiddleware(...);

### Removed `req.url` patching

When proxy is mounted on a path, this path should be provided in the target.

```js
// before
app.use('/user', proxy({ target: 'http://www.example.org' }));
Expand Down
1 change: 0 additions & 1 deletion README.md
Expand Up @@ -4,7 +4,6 @@
[![Coveralls](https://img.shields.io/coveralls/chimurai/http-proxy-middleware.svg?style=flat-square&logo=coveralls)](https://coveralls.io/r/chimurai/http-proxy-middleware)
[![Known Vulnerabilities](https://snyk.io/test/github/chimurai/http-proxy-middleware/badge.svg)](https://snyk.io/test/github/chimurai/http-proxy-middleware)
[![npm](https://img.shields.io/npm/v/http-proxy-middleware?color=%23CC3534&style=flat-square&logo=npm)](https://www.npmjs.com/package/http-proxy-middleware)
[![npm (tag)](https://img.shields.io/npm/v/http-proxy-middleware/beta?color=CC3534&logo=npm&style=flat-square)](https://github.com/chimurai/http-proxy-middleware/discussions/768)

Node.js proxying made simple. Configure proxy middleware with ease for [connect](https://github.com/senchalabs/connect), [express](https://github.com/expressjs/express), [next.js](https://github.com/vercel/next.js) and [many more](#compatible-servers).

Expand Down
2 changes: 1 addition & 1 deletion package.json
@@ -1,6 +1,6 @@
{
"name": "http-proxy-middleware",
"version": "3.0.0-beta.1",
"version": "3.0.0",
"description": "The one-liner node.js proxy middleware for connect, express, next.js and more",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down

0 comments on commit 84bfa46

Please sign in to comment.