From 55411dfd24ef17e2b0d584266c578654989c2bcd Mon Sep 17 00:00:00 2001 From: Damien Arrachequesne Date: Tue, 3 Jan 2017 08:03:37 +0100 Subject: [PATCH] [docs] Add `connect_error` and `connect_timeout` events (#1051) --- docs/API.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/API.md b/docs/API.md index 5f17377612..78170653c6 100644 --- a/docs/API.md +++ b/docs/API.md @@ -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.