Skip to content

docs: document upgradeWebSocket and rework cross-isolate messaging #5484

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

Open
philip wants to merge 5 commits into
base: main
Choose a base branch
from
+230 −48
Open

docs: document upgradeWebSocket and rework cross-isolate messaging #5484

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f10e774
docs: document upgradeWebSocket on Neon Functions
philip Aug 7, 2026
c9658cb
docs: whitespace
philip Aug 7, 2026
65dfa93
docs: correct websocket handshake-refusal guidance
philip Sep 1, 2026
21f7592
docs: expand and correct the websockets and SSE guide
philip Sep 1, 2026
ec146a1
docs: skip closing sockets in the websockets polling loop
philip Sep 1, 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
4 changes: 4 additions & 0 deletions content/docs/cli/dev.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,7 @@ Serve one function on an explicit port (fails if the port is taken):
```bash
neon dev --source ./functions/hello.ts --port 3000
```

## WebSockets

`neon dev` serves WebSocket upgrades locally, so you can test real-time functions before you deploy. Both patterns work: `upgradeWebSocket` from `@neon/functions` and an `upgrade` export. Connect a client to the dev server's `ws://localhost:<port>` URL. See [WebSockets and SSE](/docs/compute/functions/websockets) for the function-side code.
Loading
Loading