Add documentation comment

smogon · Oct 21, 2020 · abe4409 · abe4409
1 parent d89de46
commit abe4409
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/server/chat-plugins/poll.ts b/server/chat-plugins/poll.ts
@@ -444,7 +444,9 @@ export const commands: ChatCommands = {
 					return this.add(this.tr("The poll timer was turned off."));
 				}
 				const timeout = parseFloat(target);
-				if (isNaN(timeout) || timeout <= 0 || timeout > Chat.MAX_TIMEOUT_DURATION) return this.errorReply(this.tr("Invalid time given."));
+				if (isNaN(timeout) || timeout <= 0 || timeout > Chat.MAX_TIMEOUT_DURATION) {
+					return this.errorReply(this.tr("Invalid time given."));
+				}
 				if (poll.timeout) clearTimeout(poll.timeout);
 				poll.timeoutMins = timeout;
 				poll.timeout = setTimeout(() => {

diff --git a/server/chat.ts b/server/chat.ts
@@ -1368,7 +1368,12 @@ export const Chat = new class {
 		});
 	}
 	translationsLoaded = false;
-	readonly MAX_TIMEOUT_DURATION = 2147483647; // (2^32 / 2) - 1
+	/**
+	 * As per the node.js documentation at https://nodejs.org/api/timers.html#timers_settimeout_callback_delay_args,
+	 * timers with durations that are too long for a 32-bit signed integer will be invoked after 1 millisecond,
+	 * which tends to cause unexpected behavior.
+	 */
+	readonly MAX_TIMEOUT_DURATION = 2147483647;
 
 	readonly multiLinePattern = new PatternTester();