Skip to content

docs: add migration guide from connect to connect-next #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chenjiahan merged 2 commits into from
Mar 9, 2026
Merged

docs: add migration guide from connect to connect-next #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
82e9777
docs: add migration guide from connect to connect-next
chenjiahan Mar 9, 2026
a3ce531
docs
chenjiahan Mar 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,24 @@ Connect is a simple framework to glue together various "middleware" to handle re
$ npm install connect-next
```

### Migrate from `connect`

If you are migrating from `connect`, remove the previous packages and install `connect-next`:

```sh
$ npm remove connect @types/connect
$ npm install connect-next
```

`connect-next` ships its own TypeScript types, so `@types/connect` is no longer needed.

The package also exposes a named `connect` export instead of a default import:

```diff
-import connect from 'connect';
+import { connect } from 'connect-next';
```

### Create an app

The main component is a Connect "app". This will store all the middleware
Expand Down