Skip to content

Commit

Permalink
[docs] Add connect_error and connect_timeout events (#1051)
Browse files Browse the repository at this point in the history
  • Loading branch information
darrachequesne authored Jan 3, 2017
1 parent 558163d commit 55411df
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 55411df

Please sign in to comment.