Instalación del servidor

información

La última versión actualmente es 4.8.1, lanzada en octubre de 2024.

Puedes encontrar las notas de la versión aquí.

Prerrequisitos

Por favor asegúrate de que Node.js esté instalado en tu sistema. La versión actual de Soporte a Largo Plazo (LTS) es un punto de partida ideal, ver aquí.

información

Se necesita al menos Node.js 10, las versiones anteriores ya no son soportadas.

Instalación

Para instalar la última versión:

NPM

npm install socket.io

Yarn

yarn add socket.io

pnpm

pnpm add socket.io

Bun

bun add socket.io

Para instalar una versión específica:

NPM

npm install socket.io@version

Yarn

yarn add socket.io@version

pnpm

pnpm add socket.io@version

Bun

bun add socket.io@version

Paquetes adicionales

Por defecto, Socket.IO usa el servidor WebSocket proporcionado por el paquete ws.

Hay 2 paquetes opcionales que se pueden instalar junto con este paquete. Estos paquetes son complementos binarios que mejoran ciertas operaciones. Los binarios precompilados están disponibles para las plataformas más populares, así que no necesariamente necesitas tener un compilador C++ instalado en tu máquina.

• bufferutil: Permite realizar eficientemente operaciones como enmascarar y desenmascarar la carga de datos de los frames WebSocket.
• utf-8-validate: Permite verificar eficientemente si un mensaje contiene UTF-8 válido como lo requiere la especificación.

Para instalar esos paquetes:

NPM

npm install --save-optional bufferutil utf-8-validate

Yarn

yarn add --optional bufferutil utf-8-validate

pnpm

pnpm add -O bufferutil utf-8-validate

Bun

bun add --optional bufferutil utf-8-validate

Por favor nota que estos paquetes son opcionales, el servidor WebSocket recurrirá a la implementación en JavaScript si no están disponibles. Más información se puede encontrar aquí.

Otras implementaciones de servidor WebSocket

Cualquier implementación de servidor WebSocket que exponga la misma API que ws (notablemente el método handleUpgrade) puede ser usada.

Por ejemplo, puedes usar el paquete eiows, que es un fork del paquete (ahora obsoleto) uws:

NPM

npm install eiows

Yarn

yarn add eiows

pnpm

pnpm add eiows

Bun

bun add eiows

Y luego usa la opción wsEngine:

const { Server } = require("socket.io");
const eiows = require("eiows");

const io = new Server(3000, {
  wsEngine: eiows.Server
});

Esta implementación "permite, pero no garantiza" mejoras significativas de rendimiento y uso de memoria sobre la implementación predeterminada. Como siempre, por favor haz benchmarks contra tu propio uso.

Uso con µWebSockets.js

A partir de la versión 4.4.0, un servidor Socket.IO ahora puede vincularse a un servidor µWebSockets.js.

Instalación:

NPM

npm install uWebSockets.js@uNetworking/uWebSockets.js#v20.52.0

Yarn

yarn add uWebSockets.js@uNetworking/uWebSockets.js#v20.52.0

pnpm

pnpm add uWebSockets.js@uNetworking/uWebSockets.js#v20.52.0

Bun

bun add uWebSockets.js@uNetworking/uWebSockets.js#v20.52.0

Uso:

const { App } = require("uWebSockets.js");
const { Server } = require("socket.io");

const app = App();
const io = new Server();

io.attachApp(app);

io.on("connection", (socket) => {
  // ...
});

app.listen(3000, (token) => {
  if (!token) {
    console.warn("puerto ya en uso");
  }
});

Uso con Bun

El paquete @socket.io/bun-engine proporciona un motor de bajo nivel específico para Bun, destinado a aprovechar la velocidad y escalabilidad de Bun.

Instalación

bun add socket.io @socket.io/bun-engine

Uso

import { Server as Engine } from "@socket.io/bun-engine";
import { Server } from "socket.io";

const io = new Server();

const engine = new Engine({
  path: "/socket.io/",
});

io.bind(engine);

io.on("connection", (socket) => {
  // ...
});

export default {
  port: 3000,
  idleTimeout: 30, // debe ser mayor que la opción "pingInterval" del motor, que por defecto es 25 segundos

  ...engine.handler(),
};

consejo

Cualquier adaptador existente puede ser usado sin ninguna modificación.

Miscelánea

Árbol de dependencias

Una instalación básica del servidor incluye 21 paquetes, de los cuales 6 son mantenidos por nuestro equipo:

└─┬ socket.io@4.8.1
  ├─┬ accepts@1.3.8
  │ ├─┬ mime-types@2.1.35
  │ │ └── mime-db@1.52.0
  │ └── negotiator@0.6.3
  ├── base64id@2.0.0
  ├─┬ cors@2.8.5
  │ ├── object-assign@4.1.1
  │ └── vary@1.1.2
  ├─┬ debug@4.3.7
  │ └── ms@2.1.3
  ├─┬ engine.io@6.6.4
  │ ├─┬ @types/cors@2.8.17
  │ │ └── @types/node@22.13.9 deduped
  │ ├─┬ @types/node@22.13.9
  │ │ └── undici-types@6.20.0
  │ ├── accepts@1.3.8 deduped
  │ ├── base64id@2.0.0 deduped
  │ ├── cookie@0.7.2
  │ ├── cors@2.8.5 deduped
  │ ├── debug@4.3.7 deduped
  │ ├── engine.io-parser@5.2.3
  │ └─┬ ws@8.17.1
  │   ├── UNMET OPTIONAL DEPENDENCY bufferutil@^4.0.1
  │   └── UNMET OPTIONAL DEPENDENCY utf-8-validate@>=5.0.2
  ├─┬ socket.io-adapter@2.5.5
  │ ├── debug@4.3.7 deduped
  │ └── ws@8.17.1 deduped
  └─┬ socket.io-parser@4.2.4
    ├── @socket.io/component-emitter@3.1.2
    └── debug@4.3.7 deduped

información

Las declaraciones de tipos para paquetes de terceros están incluidas, para facilitar el uso de la biblioteca para usuarios de TypeScript (pero a costa de un paquete ligeramente más grande).

Ver también: https://github.com/microsoft/types-publisher/issues/81#issuecomment-234051345

Versiones transitivas

El paquete engine.io trae el motor que es responsable de gestionar las conexiones de bajo nivel (HTTP long-polling o WebSocket). Ver también: Cómo funciona

versión de socket.io	versión de engine.io	versión de ws
4.8.x	6.6.x	8.17.x
4.7.x	6.5.x	8.17.x
4.6.x	6.4.x	8.11.x
4.5.x	6.2.x	8.2.x
4.4.x	6.1.x	8.2.x
4.3.x	6.0.x	8.2.x
4.2.x	5.2.x	7.4.x
4.1.x	5.1.x	7.4.x
4.0.x	5.0.x	7.4.x
3.1.x	4.1.x	7.4.x
3.0.x	4.0.x	7.4.x
2.5.x	3.6.x	7.5.x
2.4.x	3.5.x	7.4.x