Make JSDocs follow general conventions (#582)

* Make JSDocs follow usual conventions

* Fix StringResolvable name

* Make function lowercase
This commit is contained in:
Schuyler Cebulskie
2016-09-03 04:57:25 -04:00
committed by Amish Shah
parent 44efcf3f52
commit 27652b94af
33 changed files with 262 additions and 262 deletions

View File

@@ -14,17 +14,17 @@ class ClientManager {
this.client = client;
/**
* The heartbeat interval, null if not yet set
* @type {?Number}
* @type {?number}
*/
this.heartbeatInterval = null;
}
/**
* Connects the Client to the WebSocket
* @param {String} token the authorization token
* @param {Function} resolve function to run when connection is successful
* @param {Function} reject function to run when connection fails
* @returns {null}
* @param {string} token the authorization token
* @param {function} resolve function to run when connection is successful
* @param {function} reject function to run when connection fails
* @returns {void}
*/
connectToWebSocket(token, resolve, reject) {
this.client.token = token;
@@ -40,8 +40,8 @@ class ClientManager {
/**
* Sets up a keep-alive interval to keep the Client's connection valid
* @param {Number} time the interval in milliseconds at which heartbeat packets should be sent
* @returns {null}
* @param {number} time the interval in milliseconds at which heartbeat packets should be sent
* @returns {void}
*/
setupKeepAlive(time) {
this.heartbeatInterval = this.client.setInterval(() => {