Skip to main content
Version: 4.x

Client API

IO#

Exposed as the io namespace in the standalone build, or the result of calling require("socket.io-client").

<script src="/socket.io/socket.io.js"></script><script>  const socket = io("http://localhost");</script>
const io = require("socket.io-client");// or with import syntaximport { io } from "socket.io-client";

io.protocol#

  • (Number)

The protocol revision number (currently: 5).

The protocol defines the format of the packets exchanged between the client and the server. Both the client and the server must use the same revision in order to understand each other.

You can find more information here.

io([url][, options])#

  • url (String) (defaults to window.location)
  • options (Object)
    • forceNew (Boolean) whether to reuse an existing connection
  • Returns Socket

Creates a new Manager for the given URL, and attempts to reuse an existing Manager for subsequent calls, unless the multiplex option is passed with false. Passing this option is the equivalent of passing "force new connection": true or forceNew: true.

A new Socket instance is returned for the namespace specified by the pathname in the URL, defaulting to /. For example, if the url is http://localhost/users, a transport connection will be established to http://localhost and a Socket.IO connection will be established to /users.

Query parameters can also be provided, either with the query option or directly in the url (example: http://localhost/users?token=abc).

const io = require("socket.io-client");
const socket = io("ws://example.com/my-namespace", {  reconnectionDelayMax: 10000,  auth: {    token: "123"  },  query: {    "my-key": "my-value"  }});

is the short version of:

const { Manager } = require("socket.io-client");
const manager = new Manager("ws://example.com", {  reconnectionDelayMax: 10000,  query: {    "my-key": "my-value"  }});
const socket = manager.socket("/my-namespace", {  auth: {    token: "123"  }});

See new Manager(url[, options]) for the list of available options.

Please note: manager.socket("/my-namespace", options ) will only read the auth key in the options object. query: {…} and other optional values are only used when passed via a new Manager(uri, options) instance.

See Migrating from 2.x to 3.0 for more on the difference between the auth and query options.

Manager#

The Manager manages the Engine.IO client instance, which is the low-level engine that establishes the connection to the server (by using transports like WebSocket or HTTP long-polling).

The Manager handles the reconnection logic.

A single Manager can be used by several Sockets. You can find more information about this multiplexing feature here.

Please note that, in most cases, you won't use the Manager directly but use the Socket instance instead.

new Manager(url[, options])#

  • url (String)
  • options (Object)
  • Returns Manager

Available options:

OptionDefault valueDescription
path/socket.ioname of the path that is captured on the server side
reconnectiontruewhether to reconnect automatically
reconnectionAttemptsInfinitynumber of reconnection attempts before giving up
reconnectionDelay1000how long to initially wait before attempting a new reconnection. Affected by +/- randomizationFactor, for example the default initial delay will be between 500 to 1500ms.
reconnectionDelayMax5000maximum amount of time to wait between reconnections. Each attempt increases the reconnection delay by 2x along with a randomization factor.
randomizationFactor0.50 <= randomizationFactor <= 1
timeout20000connection timeout before an error event is emitted
autoConnecttrueby setting this false, you have to call manager.open whenever you decide it's appropriate
query{}additional query parameters that are sent when connecting a namespace (then found in socket.handshake.query object on the server-side)
parser-the parser to use. Defaults to an instance of the Parser that ships with socket.io. See socket.io-parser.

Available options for the underlying Engine.IO client:

OptionDefault valueDescription
upgradetruewhether the client should try to upgrade the transport from long-polling to something better.
forceJSONPfalseforces JSONP for polling transport.
jsonptruedetermines whether to use JSONP when necessary for polling. If disabled (by settings to false) an error will be emitted (saying "No transports available") if no other transports are available. If another transport is available for opening a connection (e.g. WebSocket) that transport will be used instead.
forceBase64falseforces base 64 encoding for polling transport even when XHR2 responseType is available and WebSocket even if the used standard supports binary.
enablesXDRfalseenables XDomainRequest for IE8 to avoid loading bar flashing with click sound. default to false because XDomainRequest has a flaw of not sending cookie.
timestampRequests-whether to add the timestamp with each transport request. Note: polling requests are always stamped unless this option is explicitly set to false
timestampParamtthe timestamp parameter
transports["polling", "websocket"]a list of transports to try (in order). Engine always attempts to connect directly with the first one, provided the feature detection test for it passes.
transportOptions{}hash of options, indexed by transport name, overriding the common options for the given transport
rememberUpgradefalseIf true and if the previous websocket connection to the server succeeded, the connection attempt will bypass the normal upgrade process and will initially try websocket. A connection attempt following a transport error will use the normal upgrade process. It is recommended you turn this on only when using SSL/TLS connections, or if you know that your network does not block websockets.
onlyBinaryUpgradesfalsewhether transport upgrades should be restricted to transports supporting binary data
requestTimeout0timeout for xhr-polling requests in milliseconds (0) (only for polling transport)
protocols-a list of subprotocols (see MDN reference) (only for websocket transport)

Node.js-only options for the underlying Engine.IO client:

OptionDefault valueDescription
agentfalse the http.Agent to use
pfx-Certificate, Private key and CA certificates to use for SSL.
key-Private key to use for SSL.
passphrase-A string of passphrase for the private key or pfx.
cert-Public x509 certificate to use.
ca-An authority certificate or array of authority certificates to check the remote host against.
ciphers-A string describing the ciphers to use or exclude. Consult the cipher format list for details on the format.
rejectUnauthorizedtrueIf true, the server certificate is verified against the list of supplied CAs. An "error" event is emitted if verification fails. Verification happens at the connection level, before the HTTP request is sent.
perMessageDeflatetrueparameters of the WebSocket permessage-deflate extension (see ws module api docs). Set to false to disable.
extraHeaders{}Headers that will be passed for each request to the server (via xhr-polling and via websockets). These values then can be used during handshake or for special proxies.
forceNodefalseUses NodeJS implementation for websockets - even if there is a native Browser-Websocket available, which is preferred by default over the NodeJS implementation. (This is useful when using hybrid platforms like nw.js or electron)
localAddress-the local IP address to connect to

manager.reconnection([value])#

  • value (Boolean)
  • Returns Manager|Boolean

Sets the reconnection option, or returns it if no parameters are passed.

manager.reconnectionAttempts([value])#

  • value (Number)
  • Returns Manager|Number

Sets the reconnectionAttempts option, or returns it if no parameters are passed.

manager.reconnectionDelay([value])#

  • value (Number)
  • Returns Manager|Number

Sets the reconnectionDelay option, or returns it if no parameters are passed.

manager.reconnectionDelayMax([value])#

  • value (Number)
  • Returns Manager|Number

Sets the reconnectionDelayMax option, or returns it if no parameters are passed.

manager.timeout([value])#

  • value (Number)
  • Returns Manager|Number

Sets the timeout option, or returns it if no parameters are passed.

manager.open([callback])#

  • callback (Function)
  • Returns Manager

If the manager was initiated with autoConnect to false, launch a new connection attempt.

The callback argument is optional and will be called once the attempt fails/succeeds.

manager.connect([callback])#

Synonym of manager.open([callback]).

manager.socket(nsp, options)#

  • nsp (String)
  • options (Object)
  • Returns Socket

Creates a new Socket for the given namespace. Only auth ({ auth: {key: "value"} }) is read from the options object. Other keys will be ignored and should be passed when instancing a new Manager(nsp, options).

Event: 'error'#

  • error (Object) error object

Fired upon a connection error.

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

Event: 'reconnect'#

  • attempt (Number) reconnection attempt number

Fired upon a successful reconnection.

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

Event: 'reconnect_attempt'#

  • attempt (Number) reconnection attempt number

Fired upon an attempt to reconnect.

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

Event: 'reconnect_error'#

  • error (Object) error object

Fired upon a reconnection attempt error.

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

Event: 'reconnect_failed'#

Fired when couldn't reconnect within reconnectionAttempts.

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

Event: 'ping'#

Fired when a ping packet is received from the server.

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

Socket#

A Socket is the fundamental class for interacting with the server. A Socket belongs to a certain Namespace (by default /) and uses an underlying Manager to communicate.

A Socket is basically an EventEmitter which sends events to — and receive events from — the server over the network.

socket.emit("hello", { a: "b", c: [] });
socket.on("hey", (...args) => {  // ...});

More information can be found here.

socket.id#

  • (String)

An unique identifier for the socket session. Set after the connect event is triggered, and updated after the reconnect event.

const socket = io("http://localhost");
console.log(socket.id); // undefined
socket.on("connect", () => {  console.log(socket.id); // "G5p5..."});

socket.connected#

  • (Boolean)

Whether or not the socket is connected to the server.

const socket = io("http://localhost");
socket.on("connect", () => {  console.log(socket.connected); // true});

socket.disconnected#

  • (Boolean)

Whether or not the socket is disconnected from the server.

const socket = io("http://localhost");
socket.on("connect", () => {  console.log(socket.disconnected); // false});

socket.connect()#

Added in v1.0.0
  • Returns Socket

Manually connects the socket.

const socket = io({  autoConnect: false});
// ...socket.connect();

It can also be used to manually reconnect:

socket.on("disconnect", () => {  socket.connect();});

socket.open()#

Added in v1.0.0

Synonym of socket.connect().

socket.send([...args][, ack])#

  • args
  • ack (Function)
  • Returns Socket

Sends a message event. See socket.emit(eventName[, ...args][, ack]).

socket.emit(eventName[, ...args][, ack])#

  • eventName (String)
  • args
  • ack (Function)
  • Returns true

Emits an event to the socket identified by the string name. Any other parameters can be included. All serializable datastructures are supported, including Buffer.

socket.emit("hello", "world");socket.emit("with-binary", 1, "2", { 3: "4", 5: Buffer.from([6, 7, 8]) });

The ack argument is optional and will be called with the server answer.

socket.emit("ferret", "tobi", (data) => {  console.log(data); // data will be "woot"});
// server://  io.on("connection", (socket) => {//    socket.on("ferret", (name, fn) => {//      fn("woot");//    });//  });

socket.on(eventName, callback)#

  • eventName (String)
  • callback (Function)
  • Returns Socket

Register a new handler for the given event.

socket.on("news", (data) => {  console.log(data);});
// with multiple argumentssocket.on("news", (arg1, arg2, arg3, arg4) => {  // ...});// with callbacksocket.on("news", (cb) => {  cb(0);});

The socket actually inherits every method of the Emitter class, like hasListeners, once or off (to remove an event listener).

socket.onAny(callback)#

  • callback (Function)

Register a new catch-all listener.

socket.onAny((event, ...args) => {  console.log(`got ${event}`);});

socket.prependAny(callback)#

  • callback (Function)

Register a new catch-all listener. The listener is added to the beginning of the listeners array.

socket.prependAny((event, ...args) => {  console.log(`got ${event}`);});

socket.offAny([listener])#

  • listener (Function)

Removes the previously registered listener. If no listener is provided, all catch-all listeners are removed.

const myListener = () => { /* ... */ };
socket.onAny(myListener);
// then, latersocket.offAny(myListener);
socket.offAny();

socket.listenersAny()#

  • Returns Function[]

Returns the list of registered catch-all listeners.

const listeners = socket.listenersAny();

socket.compress(value)#

  • value (Boolean)
  • Returns Socket

Sets a modifier for a subsequent event emission that the event data will only be compressed if the value is true. Defaults to true when you don't call the method.

socket.compress(false).emit("an event", { some: "data" });

socket.disconnect()#

Added in v1.0.0
  • Returns Socket

Manually disconnects the socket. In that case, the socket will not try to reconnect.

Associated disconnection reason:

  • client-side: "io client disconnect"
  • server-side: "client namespace disconnect"

If this is the last active Socket instance of the Manager, the low-level connection will be closed.

socket.close()#

Added in v1.0.0

Synonym of socket.disconnect().

Flag: 'volatile'#

Added in v3.0.0

Sets a modifier for the subsequent event emission indicating that the packet may be dropped if:

  • the socket is not connected
  • the low-level transport is not writable (for example, when a POST request is already running in HTTP long-polling mode)
socket.volatile.emit(/* ... */); // the server may or may not receive it

Event: 'connect'#

Fired upon connection to the Namespace (including a successful reconnection).

socket.on("connect", () => {  // ...});
// note: you should register event handlers outside of connect,// so they are not registered again on reconnectionsocket.on("myevent", () => {  // ...});

Event: 'disconnect'#

  • reason (String)

Fired upon disconnection. The list of possible disconnection reasons:

ReasonDescription
io server disconnectThe server has forcefully disconnected the socket with socket.disconnect()
io client disconnectThe socket was manually disconnected using socket.disconnect()
ping timeoutThe server did not send a PING within the pingInterval + pingTimeout range
transport closeThe connection was closed (example: the user has lost connection, or the network was changed from WiFi to 4G)
transport errorThe connection has encountered an error (example: the server was killed during a HTTP long-polling cycle)

In the first two cases (explicit disconnection), the client will not try to reconnect and you need to manually call socket.connect().

In all other cases, the client will wait for a small random delay and then try to reconnect:

socket.on("disconnect", (reason) => {  if (reason === "io server disconnect") {    // the disconnection was initiated by the server, you need to reconnect manually    socket.connect();  }  // else the socket will automatically try to reconnect});

Event: 'connect_error'#

  • connect_error (Object) error object

Fired when an namespace middleware error occurs.

socket.on("connect_error", (error) => {  // ...});