github/socket.io
1
1
Fork 0
mirror of https://github.com/socketio/socket.io.git synced 2026-04-30 03:00:39 -04:00
Code Issues Packages Projects Releases Wiki Activity

[docs] Add connect_error and connect_timeout events (#1051)

Browse Source
This commit is contained in:
Damien Arrachequesne
2017-01-03 08:03:37 +01:00
committed by GitHub
parent 558163d766
commit 55411dfd24
1 changed files with 13 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/API.md
View File

@@ -34,6 +34,8 @@
- [socket.close()](#socketclose)
- [socket.disconnect()](#socketdisconnect)
- [Event: 'connect'](#event-connect)
- [Event: 'connect_error'](#event-connect_error-1)
- [Event: 'connect_timeout'](#event-connect_timeout-1)
- [Event: 'error'](#event-error)
- [Event: 'disconnect'](#event-disconnect)
- [Event: 'reconnect'](#event-reconnect-1)
@@ -294,12 +296,22 @@ Synonym of [socket.close()](#socketclose).
Fired upon a connection including a successful reconnection.
#### Event: 'error'
#### Event: 'connect_error'
- `error` _(Object)_ error object
Fired upon a connection error.
#### Event: 'connect_timeout'
Fired upon a connection timeout.
#### Event: 'error'
- `error` _(Object)_ error object
Fired when an error occurs.
#### Event: 'disconnect'
Fired upon a disconnection.