voice icon indicating copy to clipboard operation
voice copied to clipboard

VoiceReceiver constructor should probably be marked @internal

Open iliazeus opened this issue 3 years ago • 0 comments

Please describe the problem you are having in as much detail as possible:

Upgrading from 0.5.x versions, changing createVoiceRecevier(connection) to new VoiceReceiver(connection) seemed to be the logical choice. However, the only VoiceReceiver that works with a given connection seems to be the VoiceConnection.receiver.

I suggest marking the VoiceReceiver constructor as @internal, to avoid confusion.

Include a reproducible code sample here, if possible:

const r1 = new VoiceReceiver(voiceConnection);
r1.speaking.on("start", () => console.log("never gets called"));

const r2 = voiceConnection.receiver;
r2.speaking.on("start", () => console.log("but this one does"));

Further details:

  • @discordjs/voice version: 0.6.0
  • Priority this issue should have – please be realistic and elaborate if possible: same as all documentation issues, probably

Relevant client options:

  • partials: none
  • gateway intents: none
  • other: none

iliazeus avatar Aug 25 '21 07:08 iliazeus