68 lines
2.4 KiB
Markdown
68 lines
2.4 KiB
Markdown
|
|
|||
|
|
# socket.io-client
|
|||
|
|
|
|||
|
|
[](https://github.com/socketio/socket.io-client/actions)
|
|||
|
|
[](https://david-dm.org/socketio/socket.io-client)
|
|||
|
|
[](https://david-dm.org/socketio/socket.io-client#info=devDependencies)
|
|||
|
|
[](https://www.npmjs.com/package/socket.io-client)
|
|||
|
|
|
|||
|
|
[](http://slack.socket.io)
|
|||
|
|
|
|||
|
|
[](https://saucelabs.com/u/socket)
|
|||
|
|
|
|||
|
|
## 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](https://cdn.jsdelivr.net/npm/socket.io-client@2/dist/socket.io.js).
|
|||
|
|
|
|||
|
|
```html
|
|||
|
|
<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>
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
```js
|
|||
|
|
// 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](http://browserify.org/) and [webpack](https://webpack.js.org/) (see example [there](https://github.com/socketio/socket.io/tree/2.0.3/examples/webpack-build)).
|
|||
|
|
|
|||
|
|
### Node.JS (server-side usage)
|
|||
|
|
|
|||
|
|
Add `socket.io-client` to your `package.json` and then:
|
|||
|
|
|
|||
|
|
```js
|
|||
|
|
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](/docs/API.md)
|
|||
|
|
|
|||
|
|
## License
|
|||
|
|
|
|||
|
|
[MIT](/LICENSE)
|