Merge pull request #106 from Kapcash/documentation-updates

fix#86: "Updating README.md: on express example, variable names clearer"
This commit is contained in:
Jairo Caro-Accino Viciana 2018-06-05 09:48:14 +02:00 committed by GitHub
commit 77779e2fba
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -78,21 +78,28 @@ var ExpressPeerServer = require('peer').ExpressPeerServer;
app.get('/', function(req, res, next) { res.send('Hello world!'); });
// =======
var server = app.listen(9000);
var options = {
debug: true
}
app.use('/api', ExpressPeerServer(server, options));
var peerserver = ExpressPeerServer(server, options);
// OR
app.use('/api', peerserver);
// == OR ==
var server = require('http').createServer(app);
var peerserver = ExpressPeerServer(server, options);
app.use('/peerjs', ExpressPeerServer(server, options));
app.use('/peerjs', peerserver);
server.listen(9000);
// ========
```
### Events
@ -100,14 +107,14 @@ server.listen(9000);
The `'connection'` event is emitted when a peer connects to the server.
```javascript
server.on('connection', function(id) { ... });
peerserver.on('connection', function(id) { ... });
```
The `'disconnect'` event is emitted when a peer disconnects from the server or
when the peer can no longer be reached.
```javascript
server.on('disconnect', function(id) { ... });
peerserver.on('disconnect', function(id) { ... });
```
## Problems?