Skip to content

Commit 9eee2a5

Browse files
committed
docs: add v5 beta announcement and upgrade guide
- Add announcement banner for v5.0.0 beta release - Note v4.x maintenance mode status - Add "From 4.x to 5.x" section to UPGRADE.md with breaking changes
1 parent d9be538 commit 9eee2a5

File tree

2 files changed

+61
-0
lines changed

2 files changed

+61
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
11

2+
> **v5.0.0 Beta Released!** Version 5.0.0 is now available in beta with Node.js 24 support, removal of deprecated APIs, and a fix for nested routes and custom domains. Install with: `npm install @codegenie/serverless-express@beta`
3+
>
4+
> Upgrading should be seamless unless you relied on deprecated APIs. See [UPGRADE.md](UPGRADE.md#from-4x-to-5x) for details.
5+
>
6+
> **Note:** Version 4.x is now in maintenance mode and will only receive critical bug fixes.
7+
28
<h2 align="center">Serverless Express by</h1>
39
<p align="center">
410
<a href="https://codegenie.codes">

UPGRADE.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,58 @@
1+
## From 4.x to 5.x
2+
3+
### Minimum Node.js Version
4+
5+
v5.x officially supports Node.js 24 and later, though it will likely work for earlier versions.
6+
7+
### Handler Changes
8+
9+
The handler no longer accepts a `callback` parameter. It must be used with async/Promise patterns only.
10+
11+
```javascript
12+
// 4.x (still works but callback-based patterns no longer supported)
13+
exports.handler = serverlessExpress({ app })
14+
15+
// 5.x (same, but MUST be async/Promise-based)
16+
export default serverlessExpress({ app })
17+
```
18+
19+
### Removed Options
20+
21+
The following configuration options have been removed:
22+
23+
- `resolutionMode` - Only Promise-based resolution is supported now
24+
- `binaryMimeTypes` - Use `binarySettings` instead
25+
26+
```javascript
27+
// 4.x (deprecated)
28+
serverlessExpress({
29+
app,
30+
resolutionMode: 'CALLBACK', // ❌ Removed
31+
binaryMimeTypes: ['image/*'] // ❌ Removed
32+
})
33+
34+
// 5.x
35+
serverlessExpress({
36+
app,
37+
binarySettings: {
38+
contentTypes: ['image/*']
39+
}
40+
})
41+
```
42+
43+
### Removed Methods
44+
45+
The following deprecated methods have been removed:
46+
47+
- `serverlessExpress.createServer()` - Use `serverlessExpress({ app })` instead
48+
- `serverlessExpress.proxy()` - Use `serverlessExpress({ app })` instead
49+
- `handler.handler()` - Use `handler()` directly
50+
- `handler.proxy()` - Use `handler()` directly
51+
52+
### Proxy Path Fix
53+
54+
v5.x includes a fix for nested routes and custom domains. If you use API Gateway with a custom domain and base path mapping, routes should now work correctly.
55+
156
## From 3.x to 4.x
257

358
### Lambda Handler

0 commit comments

Comments
 (0)