Fix weird options comments

This commit is contained in:
abalabahaha
2016-04-20 20:12:52 -07:00
parent 533d49d7d4
commit 283c99dee8
4 changed files with 10 additions and 10 deletions

View File

@@ -55,7 +55,7 @@ var Client = (function (_EventEmitter) {
* @example
* // creates a new Client that will try to reconnect whenever it is disconnected.
* var client = new Discord.Client({
* revive : true
* autoReconnect : true
* });
*/
@@ -72,7 +72,7 @@ var Client = (function (_EventEmitter) {
*/
this.options = options || {};
this.options.compress = options.compress || !process.browser;
this.options.revive = options.revive || false;
this.options.autoReconnect = options.autoReconnect || false;
this.options.rateLimitAsError = options.rateLimitAsError || false;
this.options.largeThreshold = options.largeThreshold || 250;
this.options.maxCachedMessages = options.maxCachedMessages || 1000;

View File

@@ -12,9 +12,9 @@
* Object containing properties that can be used to alter the client's functionality.
* @typedef {(object)} ClientOptions
* @property {boolean} [compress=true] whether or not large packets that are sent over WebSockets should be compressed.
* @property {boolean} [revive=false] whether the Client should attempt to automatically reconnect if it is disconnected.
* @property {boolean} [rate_limit_as_error=false] whether rejections to API requests due to rate-limiting should be treated as errors.
* @property {Number} [large_threshold=250] an integer between 0 and 250. When a server has more users than `options.large_threshold`, only the online/active users are cached.
* @property {boolean} [autoReconnect=false] whether the Client should attempt to automatically reconnect if it is disconnected.
* @property {boolean} [rateLimitAsError=false] whether rejections to API requests due to rate-limiting should be treated as errors.
* @property {Number} [largeThreshold=250] an integer between 0 and 250. When a server has more users than `options.largeThreshold`, only the online/active users are cached.
*/
/**

View File

@@ -34,7 +34,7 @@ export default class Client extends EventEmitter {
* @example
* // creates a new Client that will try to reconnect whenever it is disconnected.
* var client = new Discord.Client({
* revive : true
* autoReconnect : true
* });
*/
constructor(options = {}) {
@@ -46,7 +46,7 @@ export default class Client extends EventEmitter {
*/
this.options = options || {};
this.options.compress = options.compress || (!process.browser);
this.options.revive = options.revive || false;
this.options.autoReconnect = options.autoReconnect || false;
this.options.rateLimitAsError = options.rateLimitAsError || false;
this.options.largeThreshold = options.largeThreshold || 250;
this.options.maxCachedMessages = options.maxCachedMessages || 1000;

View File

@@ -12,9 +12,9 @@
* Object containing properties that can be used to alter the client's functionality.
* @typedef {(object)} ClientOptions
* @property {boolean} [compress=true] whether or not large packets that are sent over WebSockets should be compressed.
* @property {boolean} [revive=false] whether the Client should attempt to automatically reconnect if it is disconnected.
* @property {boolean} [rate_limit_as_error=false] whether rejections to API requests due to rate-limiting should be treated as errors.
* @property {Number} [large_threshold=250] an integer between 0 and 250. When a server has more users than `options.large_threshold`, only the online/active users are cached.
* @property {boolean} [autoReconnect=false] whether the Client should attempt to automatically reconnect if it is disconnected.
* @property {boolean} [rateLimitAsError=false] whether rejections to API requests due to rate-limiting should be treated as errors.
* @property {Number} [largeThreshold=250] an integer between 0 and 250. When a server has more users than `options.largeThreshold`, only the online/active users are cached.
*/
/**