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

ci: api-extractor support for docs

Browse Source
This commit is contained in:
iCrawl
2022-06-30 15:46:14 +02:00
parent 525bf031a5
commit b2776c22d4
54 changed files with 2608 additions and 343 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
packages/voice/src/receive/SSRCMap.ts
View File

@@ -45,7 +45,7 @@ export class SSRCMap extends EventEmitter {
/**
* Updates the map with new user data
*
* @param data The data to update with
* @param data - The data to update with
*/
public update(data: VoiceUserData) {
const existing = this.map.get(data.audioSSRC);
@@ -63,7 +63,7 @@ export class SSRCMap extends EventEmitter {
/**
* 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
*/
public get(target: number | string) {
if (typeof target === 'number') {
@@ -82,7 +82,7 @@ export class SSRCMap extends EventEmitter {
/**
* 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
*/

14
packages/voice/src/receive/VoiceReceiver.ts
View File

@@ -58,7 +58,7 @@ export 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
*/
@@ -118,10 +118,10 @@ export 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
*/
@@ -152,7 +152,7 @@ export 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
*/
@@ -186,7 +186,7 @@ export 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
*/