How to Use WebSocket in Node.js

With Node.js, a powerful JavaScript runtime, harnessing the capabilities of WebSockets becomes even more accessible and efficient. In this guide, we'll walk through the process of integrating and using WebSockets in Node.js.

David Demir

David Demir

16 May 2025

How to Use WebSocket in Node.js

WebSockets have revolutionized real-time communication on the web, enabling bidirectional, full-duplex communication channels over a single TCP connection. With Node.js, a powerful JavaScript runtime, harnessing the capabilities of WebSockets becomes even more accessible and efficient.

In this guide, we'll walk through the process of integrating and using WebSockets in Node.js.

💡
For WebSocket service debugging, use Apidog, an excellent API debugging tool offering a user-friendly interface that allows easy simulation of requests, observation of message exchanges, and modification of content, ensuring smooth functionality for WebSocket-based applications.
button

What is WebSocket?

Before diving into implementation, it's crucial to understand what WebSockets are and how they differ from traditional HTTP requests. Unlike HTTP, which follows a request-response model, WebSockets provide persistent connections between clients and servers, allowing for real-time, low-latency data exchange.

This makes them ideal for applications requiring instant updates, such as chat applications, multiplayer games, and collaborative tools.

Websocket API

WebSocket Use Cases

WebSocket is particularly meaningful in the following scenarios:

Setting Up a Node.js Project

To get started, ensure you have Node.js installed on your system. You can verify your installation by running node -v in your terminal.

How to Install Node.js and Configure Environment
Node.js is an open-source, cross-platform Javascript runtime environment based on the Chrome V8 engine. To get started with Node.js, first, you need to install it on your computer. The common ways are as follows. Check itnow.

Once confirmed, create a new directory for your project and navigate into it.

mkdir websocket-example
cd websocket-example

Initialize a new Node.js project using npm:

npm init -y

This command creates a package.json file with default settings. Next, install the ws package, a popular WebSocket library for Node.js:

npm install ws

Implementing a WebSocket Server

With the project set up, let's create a WebSocket server using the ws library. Create a new file named server.js in your project directory and add the following code:

const WebSocket = require('ws');

const wss = new WebSocket.Server({ port: 8080 });
wss.on('connection', function connection(ws) {console.log('A new client connected.');
  ws.on('message', function incoming(message) {console.log('Received: %s', message);
  });
  ws.send('Welcome to the WebSocket server!');
});

This code initializes a WebSocket server on port 8080 and listens for incoming connections. Upon connection, it logs a message and sets up an event listener for incoming messages. It also sends a welcome message to the client.

Creating a WebSocket Client

Now, let's create a simple WebSocket client to connect to our server. Create a new file named client.js in the project directory and add the following code:

const WebSocket = require('ws');

const ws = new WebSocket('ws://localhost:8080');
ws.on('open', function open() {console.log('Connected to the server.');
});
ws.on('message', function incoming(data) {console.log('Received from server: %s', data);
});

This code establishes a WebSocket connection to ws://``localhost:8080 and logs a message upon successful connection. It also sets up an event listener to receive messages from the server.

Running the Application

Before running the application, ensure that the WebSocket server (server.js) is running. You can start it by running:

node server.js

Once the server is running, execute the client script (client.js) in another terminal window:

node client.js

You should see messages indicating successful connections from both the server and the client.

Apidog: Streamlining WebSocket API Testing

Websocket in Apidog

Instead of Node.js, consider using Apidog, an excellent tool similar to Postman for versatile API testing. Apidog supports WebSocket API testing, offering user-friendly interfaces for creating, managing, and testing WebSocket APIs.

button

Explore more

Complete Guide to Creating Online API Documentation

Complete Guide to Creating Online API Documentation

Delve into the ultimate guide for creating online API documentation. Learn the essentials, best practices, and a step-by-step guide on creating online API documentation.

2 July 2025

5 Easy Methods to Control API Documentation Access in Apidog

5 Easy Methods to Control API Documentation Access in Apidog

Not all API docs should be public. With Apidog, you can control who sees what—use password protection, IP or email allowlists, or even connect your own login system. This guide walks through each method to help you choose the right one for your API access needs.

1 July 2025

Apidog SEO Settings Explained: Maximize Your API Docs Visibility

Apidog SEO Settings Explained: Maximize Your API Docs Visibility

Discover how to supercharge your API documentation's visibility with Apidog's powerful SEO features. This comprehensive guide covers everything from page-level optimizations like custom URLs and meta tags to site-wide settings such as sitemaps and robots.txt.

18 June 2025

Practice API Design-first in Apidog

Discover an easier way to build and use APIs