Need help with socket.io-client?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

socketio
8.8K Stars 2.9K Forks MIT License 1.6K Commits 218 Opened issues

Description

Realtime application framework (client)

Services available

!
?

Need anything else?

Contributors list

No Data

socket.io-client

Build Status Dependency Status devDependency Status NPM version Downloads

Sauce Test Status

How to use

A standalone build of

socket.io-client
is exposed automatically by the socket.io server as
/socket.io/socket.io.js
. Alternatively you can serve the file
socket.io.js
found in the
dist
folder or include it via CDN.
// with ES6 import
import io from 'socket.io-client';

const socket = io();

A slim build (without debug) is also available:

socket.io.slim.js
.

Socket.IO is compatible with browserify and webpack (see example there).

Node.JS (server-side usage)

Add

socket.io-client
to your
package.json
and then:
  var socket = require('socket.io-client')('http://localhost:3000');
  socket.on('connect', function(){});
  socket.on('event', function(data){});
  socket.on('disconnect', function(){});

Debug / logging

In order to see all the client debug output, run the following command on the browser console – including the desired scope – and reload your app page:

localStorage.debug = '*';

And then, filter by the scopes you're interested in. See also: https://socket.io/docs/logging-and-debugging/

API

See API

License

MIT

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.