mirror of
https://github.com/fooflington/selfdefined.git
synced 2025-06-10 21:01:41 +00:00
update
This commit is contained in:
57
node_modules/socket.io-client/README.md
generated
vendored
Normal file
57
node_modules/socket.io-client/README.md
generated
vendored
Normal file
@ -0,0 +1,57 @@
|
||||
|
||||
# socket.io-client
|
||||
|
||||
[](http://travis-ci.org/socketio/socket.io-client)
|
||||
[](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('http://localhost');
|
||||
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('http://localhost');
|
||||
```
|
||||
|
||||
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');
|
||||
socket.on('connect', function(){});
|
||||
socket.on('event', function(data){});
|
||||
socket.on('disconnect', function(){});
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
See [API](/docs/API.md)
|
||||
|
||||
## License
|
||||
|
||||
[MIT](/LICENSE)
|
Reference in New Issue
Block a user