Add notice about disabling events (#1008)

* Add notice about disabling events

* fix english

* Update Constants.js

* Update Constants.js

* Update Constants.js

* Update Constants.js
This commit is contained in:
Hackzzila
2016-12-22 14:01:04 -06:00
committed by Schuyler Cebulskie
parent 4580f62a1f
commit 84954c8860

View File

@@ -21,8 +21,9 @@ exports.Package = require('../../package.json');
* @property {number} [restWsBridgeTimeout=5000] Maximum time permitted between REST responses and their
* corresponding websocket events
* @property {WSEventType[]} [disabledEvents] An array of disabled websocket events. Events in this array will not be
* processed. Disabling useless events such as 'TYPING_START' can result in significant performance increases on
* large-scale bots.
* processed, potentially resulting in performance improvements for larger bots. Only disable events you are
* 100% certain you don't need, as many are important, but not obviously so. The safest one to disable with the
* most impact is typically `TYPING_START`.
* @property {WebsocketOptions} [ws] Options for the websocket
*/
exports.DefaultOptions = {