Server Initialization

Once you have installed the Socket.IO server library, you can now init the server. The complete list of options can be found below.

Syntax

CommonJS

  1. const httpServer = require("http").createServer();
  2. const io = require("socket.io")(httpServer, {
  3.   // ...
  4. });
  6. io.on("connection", (socket) => {
  7.   // ...
  8. });
  10. httpServer.listen(3000);

ES modules

Please see here for enabling ECMAScript modules in your Node.js project.

  1. import { createServer } from "http";
  2. import { Server } from "socket.io";
  4. const httpServer = createServer();
  5. const io = new Server(httpServer, {
  6.   // ...
  7. });
  9. io.on("connection", (socket) => {
  10.   // ...
  11. });
  13. httpServer.listen(3000);

TypeScript

Socket.IO has now first-class support for TypeScript:

  1. import { createServer } from "http";
  2. import { Server, Socket } from "socket.io";
  4. const httpServer = createServer();
  5. const io = new Server(httpServer, {
  6.   // ...
  7. });
  9. io.on("connection", (socket: Socket) => {
  10.   // ...
  11. });
  13. httpServer.listen(3000);

Initialization

Standalone

  1. const options = { /* ... */ };
  2. const io = require("socket.io")(options);
  4. io.on("connection", socket => { /* ... */ });
  6. io.listen(3000);

You can also pass the port as the first argument:

  1. const options = { /* ... */ };
  2. const io = require("socket.io")(3000, options);
  4. io.on("connection", socket => { /* ... */ });

This implicitly starts a Node.js HTTP server, which can be accessed through io.httpServer.

Attached to an existing HTTP server

With an HTTP server

  1. const httpServer = require("http").createServer();
  2. const options = { /* ... */ };
  3. const io = require("socket.io")(httpServer, options);
  5. io.on("connection", socket => { /* ... */ });
  7. httpServer.listen(3000);

With an HTTPS server

  1. const fs = require("fs");
  2. const httpServer = require("https").createServer({
  3.   key: fs.readFileSync("/tmp/key.pem"),
  4.   cert: fs.readFileSync("/tmp/cert.pem")
  5. });
  6. const options = { /* ... */ };
  7. const io = require("socket.io")(httpServer, options);
  9. io.on("connection", socket => { /* ... */ });
  11. httpServer.listen(3000);

Node.js documentation

With an HTTP/2 server

  1. const fs = require("fs");
  2. const httpServer = require("http2").createSecureServer({
  3.   allowHTTP1: true,
  4.   key: fs.readFileSync("/tmp/key.pem"),
  5.   cert: fs.readFileSync("/tmp/cert.pem")
  6. });
  7. const options = { /* ... */ };
  8. const io = require("socket.io")(httpServer, options);
  10. io.on("connection", socket => { /* ... */ });
  12. httpServer.listen(3000);

Node.js documentation

With Express

  1. const app = require("express")();
  2. const httpServer = require("http").createServer(app);
  3. const options = { /* ... */ };
  4. const io = require("socket.io")(httpServer, options);
  6. io.on("connection", socket => { /* ... */ });
  8. httpServer.listen(3000);
  9. // WARNING !!! app.listen(3000); will not work here, as it creates a new HTTP server

More information here.

With Koa

  1. const app = require("koa")();
  2. const httpServer = require("http").createServer(app.callback());
  3. const options = { /* ... */ };
  4. const io = require("socket.io")(httpServer, options);
  6. io.on("connection", socket => { /* ... */ });
  8. httpServer.listen(3000);

More information here.

Options

Socket.IO server options

path

Default value: /socket.io/

It is the name of the path that is captured on the server side.

The server and the client values must match (unless you are using a path-rewriting proxy in between):

Server

  1. const httpServer = require("http").createServer();
  2. const io = require("socket.io")(httpServer, {
  3.   path: "/my-custom-path/"
  4. });

Client

  1. import { io } from "socket.io-client";
  3. const socket = io("https://example.com", {
  4.   path: "/my-custom-path/"
  5. });

serveClient

Default value: true

Whether to serve the client files. If true, the different bundles will be served at the following location:

  • <url>/socket.io/socket.io.js
  • <url>/socket.io/socket.io.min.js
  • <url>/socket.io/socket.io.msgpack.min.js

(including their associated source maps)

See also here.

adapter

Default value: socket.io-adapter (in-memory adapter, whose source code can be found here)

The “Adapter” to use.

Example with the Redis adapter (the socket.io-redis package, more information here):

  1. const httpServer = require("http").createServer();
  2. const redisClient = require("redis").createClient();
  3. const io = require("socket.io")(httpServer, {
  4.   adapter: require("socket.io-redis")({
  5.     pubClient: redisClient,
  6.     subClient: redisClient.duplicate()
  7.   })
  8. });

parser

Default value: socket.io-parser

The parser to use. Please see the documentation here.

connectTimeout

Default value: 45000

The number of ms before disconnecting a client that has not successfully joined a namespace.

Low-level engine options

pingTimeout

Default value: 5000

This value is used in the heartbeat mechanism, which periodically checks if the connection is still alive between the server and the client.

The server sends a ping, and if the client does not answer with a pong within pingTimeout ms, the server considers that the connection is closed.

Similarly, if the client does not receive a ping from the server within pingInterval + pingTimeout ms, the client also considers that the connection is closed.

In both cases, the disconnection reason will be: ping timeout

  1. socket.on("disconnect", (reason) => {
  2.   console.log(reason); // "ping timeout"
  3. });

Note: the default value might be a bit low if you need to send big files in your application. Please increase it if that’s the case:

  1. const io = require("socket.io")(httpServer, {
  2.   pingTimeout: 30000
  3. });

pingInterval

Default value: 25000

See above.

upgradeTimeout

Default value: 10000

This is the delay in milliseconds before an uncompleted transport upgrade is cancelled.

maxHttpBufferSize

Default value: 1e6 (1 MB)

This defines how many bytes a single message can be, before closing the socket. You may increase or decrease this value depending on your needs.

  1. const io = require("socket.io")(httpServer, {
  2.   maxHttpBufferSize: 1e8
  3. });

It matches the maxPayload option of the ws package.

allowRequest

Default: -

A function that receives a given handshake or upgrade request as its first parameter, and can decide whether to continue or not.

Example:

  1. const io = require("socket.io")(httpServer, {
  2.   allowRequest: (req, callback) => {
  3.     const isOriginValid = check(req);
  4.     callback(null, isOriginValid);
  5.   }
  6. });

transports

Default value: ["polling", "websocket"]

The low-level transports that are allowed on the server-side.

See also: client-side transports

allowUpgrades

Default value: true

Whether to allow transport upgrades.

perMessageDeflate

History

VersionChanges
v3.0.0The permessage-deflate extension is now disabled by default.
v1.4.0First implementation.

Default value: false

Whether to enable the permessage-deflate extension for the WebSocket transport. This extension is known to add a significant overhead in terms of performance and memory consumption, so we suggest to only enable it if it is really needed.

Please note that if perMessageDeflate is set to false (which is the default), the compress flag used when emitting (socket.compress(true).emit(...)) will be ignored when the connection is established with WebSockets, as the permessage-deflate extension cannot be enabled on a per-message basis.

All options from the ws module are supported:

  1. const io = require("socket.io")(httpServer, {
  2.   perMessageDeflate: {
  3.     threshold: 2048, // defaults to 1024
  5.     zlibDeflateOptions: {
  6.       chunkSize: 8 * 1024, // defaults to 16 * 1024
  7.     },
  9.     zlibInflateOptions: {
  10.       windowBits: 14, // defaults to 15
  11.       memLevel: 7, // defaults to 8
  12.     },
  14.     clientNoContextTakeover: true, // defaults to negotiated value.
  15.     serverNoContextTakeover: true, // defaults to negotiated value.
  16.     serverMaxWindowBits: 10, // defaults to negotiated value.
  18.     concurrencyLimit: 20, // defaults to 10
  19.   }
  20. });

httpCompression

Added in v1.4.0

Default value: true

Whether to enable the compression for the HTTP long-polling transport.

Please note that if httpCompression is set to false, the compress flag used when emitting (socket.compress(true).emit(...)) will be ignored when the connection is established with HTTP long-polling requests.

Example:

  1. const io = require("socket.io")(httpServer, {
  2.   httpCompression: {
  3.     threshold: 2048, // defaults to 1024
  5.     chunkSize: 8 * 1024, // defaults to 16 * 1024
  6.     windowBits: 14, // defaults to 15
  7.     memLevel: 7, // defaults to 8
  8.   }
  9. });

wsEngine

Default value: "ws" (source code can be found here)

The WebSocket server implementation to use. Please see the documentation here.

Example:

  1. const io = require("socket.io")(httpServer, {
  2.   wsEngine: "eiows"
  3. });

cors

Default value: -

The list of options that will be forwarded to the cors module. More information can be found here.

Example:

  1. const io = require("socket.io")(httpServer, {
  2.   cors: {
  3.     origin: ["https://example.com", "https://dev.example.com"],
  4.     allowedHeaders: ["my-custom-header"],
  5.     credentials: true
  6.   }
  7. });

cookie

Default value: -

The list of options that will be forwarded to the cookie module.

Please note that since Socket.IO v3, there is no cookie sent by default anymore (reference).

Example:

  1. const io = require("socket.io")(httpServer, {
  2.   cookie: {
  3.     name: "my-cookie",
  4.     httpOnly: true,
  5.     sameSite: "strict",
  6.     maxAge: 86400
  7.   }
  8. });

allowEIO3

Default value: false

Whether to enable compatibility with Socket.IO v2 clients.

See also: Migrating from 2.x to 3.0

Example:

  1. const io = require("socket.io")(httpServer, {
  2.   allowEIO3: true // false by default
  3. });