mirror of
https://github.com/socketio/socket.io.git
synced 2026-04-30 03:00:39 -04:00
969debe88c
- rename "connect_error" to "error" - remove "reconnecting" (duplicate of "reconnect_attempt") The updated list of events emitted by the Manager: - open: successful (re)connection - error: (re)connection failure (previously: "connect_error") or error after a successful connection - close: disconnection - ping: ping packet - packet: data packet - reconnect_attempt: reconnection attempt (previously: "reconnect_attempt" & "reconnecting") - reconnect: successful reconnection - reconnect_error: reconnection failure - reconnect_failed: reconnection failure after all attempts For reference, the Socket instance emits the following events: - connect: successful connection to a Namespace - connect_error: connection failure - disconnect: disconnection
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