Skip to content

Commit

Permalink
[docs] Use new JavaScript syntax inside the README (#3360)
Browse files Browse the repository at this point in the history
  • Loading branch information
EmmanuelDemey authored and darrachequesne committed Nov 7, 2018
1 parent 7e35f90 commit e5f0cea
Showing 1 changed file with 20 additions and 20 deletions.
40 changes: 20 additions & 20 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,10 @@ Any serializable data structures can be emitted, including:
Sample code:

```js
io.on('connection', function(socket){
socket.emit('request', /* */); // emit an event to the socket
io.emit('broadcast', /* */); // emit an event to all connected sockets
socket.on('reply', function(){ /* */ }); // listen to the event
io.on('connection', socket => {
socket.emit('request', /* */); // emit an event to the socket
io.emit('broadcast', /* */); // emit an event to all connected sockets
socket.on('reply', () => { /* */ }); // listen to the event
});
```

Expand All @@ -84,7 +84,7 @@ This is a useful feature to send notifications to a group of users, or to a give
## Installation

```bash
npm install socket.io --save
npm install socket.io
```

## How to use
Expand All @@ -93,20 +93,20 @@ The following example attaches socket.io to a plain Node.JS
HTTP server listening on port `3000`.

```js
var server = require('http').createServer();
var io = require('socket.io')(server);
io.on('connection', function(client){
client.on('event', function(data){});
client.on('disconnect', function(){});
const server = require('http').createServer();
const io = require('socket.io')(server);
io.on('connection', client => {
client.on('event', data => { /**/ });
client.on('disconnect', () => { /**/ });
});
server.listen(3000);
```

### Standalone

```js
var io = require('socket.io')();
io.on('connection', function(client){});
const io = require('socket.io')();
io.on('connection', client => { ... });
io.listen(3000);
```

Expand All @@ -118,10 +118,10 @@ to pass the `Server` to `socket.io`, and not the express application
function. Also make sure to call `.listen` on the `server`, not the `app`.

```js
var app = require('express')();
var server = require('http').createServer(app);
var io = require('socket.io')(server);
io.on('connection', function(){ /**/ });
const app = require('express')();
const server = require('http').createServer(app);
const io = require('socket.io')(server);
io.on('connection', () => { /**/ });
server.listen(3000);
```

Expand All @@ -131,10 +131,10 @@ Like Express.JS, Koa works by exposing an application as a request
handler function, but only by calling the `callback` method.

```js
var app = require('koa')();
var server = require('http').createServer(app.callback());
var io = require('socket.io')(server);
io.on('connection', function(){ /**/ });
const app = require('koa')();
const server = require('http').createServer(app.callback());
const io = require('socket.io')(server);
io.on('connection', () => { /**/ });
server.listen(3000);
```

Expand Down

0 comments on commit e5f0cea

Please sign in to comment.