Luna 4f63b4f9a0 | ||
---|---|---|
.. | ||
dist | ||
lib | ||
node_modules | ||
CHANGELOG.md | ||
LICENSE | ||
README.md | ||
package.json |
README.md
socket.io-client
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.
<script src="/socket.io/socket.io.js"></script>
<script>
var socket = io();
socket.on('connect', function(){});
socket.on('event', function(data){});
socket.on('disconnect', function(){});
</script>
// with ES6 import
import io from 'socket.io-client';
const socket = io();
A slim build (without JSON3
, a JSON polyfill for IE6/IE7, and 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