mirror of
https://github.com/socketio/socket.io.git
synced 2026-04-30 03:00:39 -04:00
f08b933800
The `json3` dependency, previously used for compatibility with IE6/7, was removed in [1] and included in `socket.io-parser@3.0.0` and `socket.io-client@2.0.0` ([2]). The slim build now only removes the debug dependency (~3KB min+gzip). [1]e39f5a8c6a (diff-b9cfc7f2cdf78a7f4b91a753d10865a2)[2]ff4cb3eed0 (diff-b9cfc7f2cdf78a7f4b91a753d10865a2R28)
2.3 KiB
2.3 KiB
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 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