package
The realtime engine behind Socket.IO. Provides the foundation of a bidirectional connection between client and server
npm install engine.ioGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Engine.IO is the low-level realtime engine behind Socket.IO.
It provides a reliable, bidirectional communication layer between a Node.js server and a client, using HTTP long-polling first and upgrading to better transports when possible, such as WebSocket or WebTransport.
Table of Contents
http.Server integrationnpm install engine.ioimport { listen } from "engine.io";
const server = listen(8080, () => {
console.log("listening on port 8080");
});
server.on("connection", (socket) => {
socket.send("hello");
socket.on("message", (data) => {
console.log("received:", data);
});
socket.on("close", () => {
console.log("connection closed");
import { createServer } from "node:http";
import { Server } from "engine.io";
const httpServer = createServer();
const server = new Server(httpServer);
server.on("connection", (socket) => {
// ...
});
httpServer.listen(8080, () => {
console.log("listening on port 8080");
});Use this approach when you want full control over how Engine.IO requests are routed.
import { createServer } from "node:http";
import { Server } from "engine.io";
const httpServer = createServer();
const server = new Server();
httpServer.on("request", (req, res) => {
server.handleRequest(req, res);
});
httpServer.on("upgrade", (req, socket, head) => {
server.handleUpgrade(req, socket, head);
});
server.on("connection", (socket) => {
// ...
});
Engine.IO clients are provided by the engine.io-client package.
import { Socket } from "engine.io-client";
const socket = new Socket("ws://localhost:8080");
socket.on("open", () => {
socket.send("hello");
});
socket.on("message", (data) => {
console.log("received:", data);
});See the API documentation for the full list of available options, methods, events, and properties.
MIT
darrachequesne
damien.arrachequesne@gmail.com
Estimated unpacked size across 18 packages.
3.4 MB
Includes dependencies.
~5.2.1
5.2.3