Skip to content

Commit 5526a52

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 5526a52

File tree

2 files changed

+31
-0
lines changed

2 files changed

+31
-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: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,28 @@
1+
## From 4.x to 5.x
2+
3+
Upgrading from v4.x to v5.x should be seamless for most users. If you were already using the recommended async/Promise pattern with `binarySettings`, no code changes are required.
4+
5+
### Breaking Changes
6+
7+
The following deprecated APIs have been removed:
8+
9+
| Removed | Replacement |
10+
|---------|-------------|
11+
| `resolutionMode: 'CALLBACK'` | Use async/Promise (default) |
12+
| `resolutionMode: 'CONTEXT'` | Use async/Promise (default) |
13+
| `binaryMimeTypes` option | Use `binarySettings` instead |
14+
| `createServer()` export | Use `serverlessExpress({ app })` |
15+
| `proxy()` export | Use `serverlessExpress({ app })` |
16+
| `handler.handler()` | Use `serverlessExpress({ app })` |
17+
| `handler.proxy()` | Use `serverlessExpress({ app })` |
18+
| Callback parameter in handler | Use async/Promise |
19+
20+
### Node.js Version
21+
22+
v5.x officially supports Node.js 24+, aligning with AWS Lambda's latest runtime. Earlier Node.js versions may still work but are not officially supported.
23+
24+
---
25+
126
## From 3.x to 4.x
227

328
### Lambda Handler

0 commit comments

Comments
 (0)