From 6cd55ed5c994c3dcf8642bef5d58086022f3b51e Mon Sep 17 00:00:00 2001
From: SpaceEEC <SpaceEEC@users.noreply.github.com>
Date: Fri, 5 May 2017 20:15:06 +0200
Subject: [PATCH] readded docs for Client#error and Client#ready (#1466)

---
 src/client/websocket/WebSocketConnection.js | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/client/websocket/WebSocketConnection.js b/src/client/websocket/WebSocketConnection.js
index ecbcf141a..b102e05f5 100644
--- a/src/client/websocket/WebSocketConnection.js
+++ b/src/client/websocket/WebSocketConnection.js
@@ -115,6 +115,10 @@ class WebSocketConnection extends EventEmitter {
       this.debug('Tried to mark self as ready, but already ready');
       return;
     }
+    /**
+     * Emitted when the client becomes ready to start working.
+     * @event Client#ready
+     */
     this.status = Constants.Status.READY;
     this.client.emit(Constants.Events.READY);
     this.packetManager.handleQueue();
@@ -354,6 +358,11 @@ class WebSocketConnection extends EventEmitter {
    * @param {Error} error Error that occurred
    */
   onError(error) {
+    /**
+     * Emitted whenever the client's WebSocket encounters a connection error.
+     * @event Client#error
+     * @param {Error} error The encountered error
+     */
     this.client.emit(Constants.Events.ERROR, error);
     if (error.message === 'uWs client connection error') this.reconnect();
   }