@discordjs/voice 0.11.0-dev.1656547800-27d8deb → 0.11.0-dev.1656677097-741b3c8

package/dist/index.d.ts

@@ -617,7 +617,7 @@ declare class VoiceUDPSocket extends EventEmitter$1 {
     /**
      * Called when a message is received on the UDP socket.
      *
-     * @param buffer The received buffer
+     * @param buffer - The received buffer
      */
     private onMessage;
     /**
@@ -1053,19 +1053,19 @@ declare class SSRCMap extends EventEmitter$1 {
     /**
      * Updates the map with new user data
      *
-     * @param data The data to update with
+     * @param data - The data to update with
      */
     update(data: VoiceUserData): void;
     /**
      * Gets the stored voice data of a user.
      *
-     * @param target The target, either their user id or audio SSRC
+     * @param target - The target, either their user id or audio SSRC
      */
     get(target: number | string): VoiceUserData | undefined;
     /**
      * Deletes the stored voice data about a user.
      *
-     * @param target The target of the delete operation, either their audio SSRC or user id
+     * @param target - The target of the delete operation, either their audio SSRC or user id
      *
      * @returns The data that was deleted, if any
      */
@@ -1130,7 +1130,7 @@ declare class VoiceReceiver {
     /**
      * Called when a packet is received on the attached connection's WebSocket.
      *
-     * @param packet The received packet
+     * @param packet - The received packet
      *
      * @internal
      */
@@ -1139,10 +1139,10 @@ declare class VoiceReceiver {
     /**
      * Parses an audio packet, decrypting it to yield an Opus packet.
      *
-     * @param buffer The buffer to parse
-     * @param mode The encryption mode
-     * @param nonce The nonce buffer used by the connection for encryption
-     * @param secretKey The secret key used by the connection for encryption
+     * @param buffer - The buffer to parse
+     * @param mode - The encryption mode
+     * @param nonce - The nonce buffer used by the connection for encryption
+     * @param secretKey - The secret key used by the connection for encryption
      *
      * @returns The parsed Opus packet
      */
@@ -1150,7 +1150,7 @@ declare class VoiceReceiver {
     /**
      * Called when the UDP socket of the attached connection receives a message.
      *
-     * @param msg The received message
+     * @param msg - The received message
      *
      * @internal
      */
@@ -1158,7 +1158,7 @@ declare class VoiceReceiver {
     /**
      * Creates a subscription for the given user id.
      *
-     * @param target The id of the user to subscribe to
+     * @param target - The id of the user to subscribe to
      *
      * @returns A readable stream of Opus packets received from the target
      */
@@ -1615,7 +1615,7 @@ declare function entersState(target: AudioPlayer, status: AudioPlayerStatus, tim
 /**
  * Takes an Opus Head, and verifies whether the associated Opus audio is suitable to play in a Discord voice channel.
  *
- * @param opusHead The Opus Head to validate
+ * @param opusHead - The Opus Head to validate
  *
  * @returns `true` if suitable to play in a Discord voice channel, otherwise `false`
  */
@@ -1637,9 +1637,9 @@ interface ProbeInfo {
 /**
  * Attempt to probe a readable stream to figure out whether it can be demuxed using an Ogg or WebM Opus demuxer.
  *
- * @param stream The readable stream to probe
- * @param probeSize The number of bytes to attempt to read before giving up on the probe
- * @param validator The Opus Head validator function
+ * @param stream - The readable stream to probe
+ * @param probeSize - The number of bytes to attempt to read before giving up on the probe
+ * @param validator - The Opus Head validator function
  *
  * @experimental
  */

package/dist/index.js

@@ -35,14 +35,14 @@ var require_package = __commonJS({
   "package.json"(exports, module2) {
     module2.exports = {
       name: "@discordjs/voice",
-      version: "0.11.0-dev.1656547800-27d8deb",
+      version: "0.11.0-dev.1656677097-741b3c8",
       description: "Implementation of the Discord Voice API for node.js",
       scripts: {
         build: "tsup && node scripts/postbuild.mjs",
         test: "jest --coverage",
         lint: "prettier --cache --check . && eslint src __tests__ --ext mjs,js,ts --cache",
         format: "prettier --cache --write . && eslint src __tests__ --ext mjs,js,ts --fix --cache",
-        docs: "docgen -i src/index.ts -c docs/index.json -o docs/docs.json --typescript",
+        docs: "docgen -i src/index.ts -c docs/index.json -o docs/docs.json --typescript && api-extractor run --local",
         prepack: "yarn build && yarn lint && yarn test",
         changelog: "git cliff --prepend ./CHANGELOG.md -u -c ./cliff.toml -r ../../ --include-path 'packages/voice/*'",
         release: "cliff-jumper"
@@ -99,6 +99,7 @@ var require_package = __commonJS({
         "@discordjs/docgen": "workspace:^",
         "@discordjs/scripts": "workspace:^",
         "@favware/cliff-jumper": "^1.8.3",
+        "@microsoft/api-extractor": "^7.28.2",
         "@types/jest": "^28.1.2",
         eslint: "^8.18.0",
         jest: "^28.1.1",