From 84954c8860d987fced8da031f0f6fdd03612b6f2 Mon Sep 17 00:00:00 2001 From: Hackzzila Date: Thu, 22 Dec 2016 14:01:04 -0600 Subject: [PATCH] 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 --- src/util/Constants.js | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/util/Constants.js b/src/util/Constants.js index a4ce3ed90..7d415bc16 100644 --- a/src/util/Constants.js +++ b/src/util/Constants.js @@ -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 = {