Add documentation comment

smogon · Oct 21, 2020 · b9d2b6c · b9d2b6c
1 parent d89de46
commit b9d2b6c
Showing 1 changed file with 6 additions and 1 deletion.
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();