feat(ws): Allow passing in CompressionMethod to ClientOptions to use native node zlib

packages/discord.js/src/client/websocket/WebSocketManager.js

@@ -153,7 +153,8 @@ class WebSocketManager extends EventEmitter {
         updateSessionInfo: (shardId, sessionInfo) => {
           this.shards.get(shardId).sessionInfo = sessionInfo;
         },
-        compression: zlib ? CompressionMethod.ZlibStream : null,
+        compression:
+          ws.compressionMethod !== undefined ? ws.compressionMethod : zlib ? CompressionMethod.ZlibStream : null,
       };
       if (ws.buildIdentifyThrottler) wsOptions.buildIdentifyThrottler = ws.buildIdentifyThrottler;
       if (ws.buildStrategy) wsOptions.buildStrategy = ws.buildStrategy;

packages/discord.js/src/util/Options.js

@@ -87,6 +87,7 @@ const { version } = require('../../package.json');
  * @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 {CompressionMethod} [compressionMethod=undefined] The compression method to use, if any. Defaults off
  * @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>
  * @property {BuildStrategyFunction} [buildStrategy] Builds the strategy to use for sharding
@@ -122,6 +123,7 @@ class Options extends null {
       ws: {
         large_threshold: 50,
         version: 10,
+        compressionMethod: undefined,
       },
       rest: {
         ...DefaultRestOptions,

packages/discord.js/typings/index.d.ts

@@ -41,6 +41,7 @@ import { Collection, ReadonlyCollection } from '@discordjs/collection';
 import { BaseImageURLOptions, ImageURLOptions, RawFile, REST, RESTOptions } from '@discordjs/rest';
 import {
   WebSocketManager as WSWebSocketManager,
+  CompressionMethod,
   IShardingStrategy,
   IIdentifyThrottler,
   SessionInfo,
@@ -6875,6 +6876,7 @@ export interface WebhookMessageCreateOptions extends Omit<MessageCreateOptions,
 
 export interface WebSocketOptions {
   large_threshold?: number;
+  compressionMethod?: CompressionMethod;
   version?: number;
   buildStrategy?(manager: WSWebSocketManager): IShardingStrategy;
   buildIdentifyThrottler?(manager: WSWebSocketManager): Awaitable<IIdentifyThrottler>;