Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-12 01:23:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improve docs

Browse Source
This commit is contained in:
Crawl
2017-04-24 16:29:29 +02:00
parent 401822a094
commit 53eda09f72
16 changed files with 34 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/client/voice/VoiceWebSocket.js
View File

@@ -153,7 +153,7 @@ class VoiceWebSocket extends EventEmitter {
/**
* Called whenever an error occurs with the WebSocket.
* @param {Error} error the error that occurred
* @param {Error} error The error that occurred
*/
onError(error) {
this.emit('error', error);
@@ -161,7 +161,7 @@ class VoiceWebSocket extends EventEmitter {
/**
* Called whenever a valid packet is received from the WebSocket
* @param {Object} packet the received packet
* @param {Object} packet The received packet
*/
onPacket(packet) {
switch (packet.op) {
@@ -169,7 +169,7 @@ class VoiceWebSocket extends EventEmitter {
this.setHeartbeat(packet.d.heartbeat_interval);
/**
* Emitted once the voice websocket receives the ready packet
* @param {Object} packet the received packet
* @param {Object} packet The received packet
* @event VoiceWebSocket#ready
*/
this.emit('ready', packet.d);
@@ -177,8 +177,8 @@ class VoiceWebSocket extends EventEmitter {
case Constants.VoiceOPCodes.SESSION_DESCRIPTION:
/**
* Emitted once the Voice Websocket receives a description of this voice session
* @param {string} encryptionMode the type of encryption being used
* @param {SecretKey} secretKey the secret key used for encryption
* @param {string} encryptionMode The type of encryption being used
* @param {SecretKey} secretKey The secret key used for encryption
* @event VoiceWebSocket#sessionDescription
*/
this.emit('sessionDescription', packet.d.mode, new SecretKey(packet.d.secret_key));
@@ -204,7 +204,7 @@ class VoiceWebSocket extends EventEmitter {
/**
* Sets an interval at which to send a heartbeat packet to the WebSocket
* @param {number} interval the interval at which to send a heartbeat packet
* @param {number} interval The interval at which to send a heartbeat packet
*/
setHeartbeat(interval) {
if (!interval || isNaN(interval)) {
@@ -214,7 +214,7 @@ class VoiceWebSocket extends EventEmitter {
if (this.heartbeatInterval) {
/**
* Emitted whenver the voice websocket encounters a non-fatal error
* @param {string} warn the warning
* @param {string} warn The warning
* @event VoiceWebSocket#warn
*/
this.emit('warn', 'A voice heartbeat interval is being overwritten');