Skip to content

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

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
Rohan170603 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion content/guides/local-development-with-neon.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,8 @@ Imagine creating a complete copy of your database as easily as creating a Git br
```javascript
import { Pool, neon, neonConfig } from '@neondatabase/serverless';

// Uncomment the following lines if you are on environments that do not support WebSocket, e.g, Node.js
// For Node.js environments: import and configure the 'ws' package
// For browsers/Edge: WebSocket is available natively - no import needed
// import ws from 'ws';
// neonConfig.webSocketConstructor = ws;

Expand Down Expand Up @@ -226,6 +227,7 @@ For instructions on editing your hosts file on different operating systems, see

```typescript
import { neon, neonConfig, Pool } from '@neondatabase/serverless';
// Node.js environment: the 'ws' package is required for WebSocket support
import ws from 'ws';

let connectionString = process.env.DATABASE_URL;
Expand Down Expand Up @@ -291,6 +293,7 @@ For instructions on editing your hosts file on different operating systems, see
import { neon, neonConfig, Pool } from '@neondatabase/serverless';
import { drizzle as drizzleWs } from 'drizzle-orm/neon-serverless';
import { drizzle as drizzleHttp } from 'drizzle-orm/neon-http';
// Node.js environment: the 'ws' package is required for WebSocket support
import ws from 'ws';

let connectionString = process.env.DATABASE_URL;
Expand Down Expand Up @@ -393,6 +396,7 @@ Note that Driver Adapters are still in preview for Prisma. Please refer to the [
import { neonConfig } from '@neondatabase/serverless';
import { PrismaNeon, PrismaNeonHTTP } from '@prisma/adapter-neon';
import { PrismaClient } from '@prisma/client';
// Node.js environment: the 'ws' package is required for WebSocket support
import ws from 'ws';

let connectionString =
Expand Down