Skip to content

docs: clarify WebSocket package usage for Node.js vs browser environments - #5597

Open
Rohan170603 wants to merge 1 commit into
neondatabase:mainfrom
Rohan170603:docs/clarify-websocket-nodejs-guidance
Open

docs: clarify WebSocket package usage for Node.js vs browser environments#5597
Rohan170603 wants to merge 1 commit into
neondatabase:mainfrom
Rohan170603:docs/clarify-websocket-nodejs-guidance

Conversation

@Rohan170603

Copy link
Copy Markdown

Problem

The local development guide contains ambiguous comments about the ws package. The Database Branching section implies Node.js lacks WebSocket support, while the Local PostgreSQL section imports ws without explanation. This causes confusion around when the package is actually required.

Solution

  • Updated comments in Database Branching to clarify: Node.js requires ws package, browsers/Edge have native WebSocket support
  • Added explanatory comment to all three Local PostgreSQL tabs (neondatabase/serverless, Drizzle, Prisma)

Impact

  • Prevents "WebSocket is not defined" errors in Node.js
  • Avoids unnecessary ws installation in browser environments
  • Aligns with official Neon and Drizzle documentation

@vercel

vercel Bot commented Aug 20, 2026

Copy link
Copy Markdown

@Rohan170603 is attempting to deploy a commit to the neondatabase Team on Vercel.

A member of the Team first needs to authorize it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant