docs(WebSocketOptions): add version to docs and typings (#8050)

discordjs · Jun 17, 2022 · 386c41f · 386c41f
1 parent d54bf5d
commit 386c41f
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/packages/discord.js/src/util/Options.js b/packages/discord.js/src/util/Options.js
@@ -62,6 +62,8 @@ const { toSnakeCase } = require('./Transformers');
  * @typedef {Object} WebsocketOptions
  * @property {number} [large_threshold=50] Number of members in a guild after which offline users will no longer be
  * sent in the initial guild member list, must be between 50 and 250
+ * @property {number} [version=10] The Discord gateway version to use <warn>Changing this can break the library;
+ * only set this if you know what you are doing</warn>
  */
 
 /**

diff --git a/packages/discord.js/typings/index.d.ts b/packages/discord.js/typings/index.d.ts
@@ -5338,6 +5338,7 @@ export interface WebSocketOptions {
   large_threshold?: number;
   compress?: boolean;
   properties?: WebSocketProperties;
+  version?: number;
 }
 
 export interface WebSocketProperties {