refactor: deprecate $ prefix from ws.properties keys (#8095)

discordjs · Jun 17, 2022 · 3638b40 · 3638b40
1 parent 0ab2227
commit 3638b40
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/src/util/Options.js b/src/util/Options.js
@@ -157,9 +157,9 @@ class Options extends null {
         large_threshold: 50,
         compress: false,
         properties: {
-          $os: process.platform,
-          $browser: 'discord.js',
-          $device: 'discord.js',
+          os: process.platform,
+          browser: 'discord.js',
+          device: 'discord.js',
         },
         version: 9,
       },

diff --git a/typings/index.d.ts b/typings/index.d.ts
@@ -6016,8 +6016,14 @@ export interface WebSocketOptions {
 }
 
 export interface WebSocketProperties {
+  os?: string;
+  browser?: string;
+  device?: string;
+  /** @deprecated Use {@link os} instead. */
   $os?: string;
+  /** @deprecated Use {@link browser} instead. */
   $browser?: string;
+  /** @deprecated Use {@link device} instead. */
   $device?: string;
 }