mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-12 01:23:31 +01:00
Document readonly and private properties (#1338)
This commit is contained in:
@@ -23,6 +23,7 @@ class RequestHandler {
|
||||
/**
|
||||
* Whether or not the client is being rate limited on every endpoint.
|
||||
* @type {boolean}
|
||||
* @readonly
|
||||
*/
|
||||
get globalLimit() {
|
||||
return this.restManager.globallyRateLimited;
|
||||
|
||||
@@ -42,6 +42,7 @@ class VoiceBroadcast extends VolumeInterface {
|
||||
/**
|
||||
* An array of subscribed dispatchers
|
||||
* @type {StreamDispatcher[]}
|
||||
* @readonly
|
||||
*/
|
||||
get dispatchers() {
|
||||
let d = [];
|
||||
|
||||
@@ -55,6 +55,7 @@ class StreamDispatcher extends VolumeInterface {
|
||||
* How many passes the dispatcher should take when sending packets to reduce packet loss. Values over 5
|
||||
* aren't recommended, as it means you are using 5x more bandwidth. You _can_ edit this at runtime.
|
||||
* @type {number}
|
||||
* @readonly
|
||||
*/
|
||||
get passes() {
|
||||
return this.streamOptions.passes || 1;
|
||||
|
||||
@@ -53,6 +53,7 @@ class AudioPlayer extends EventEmitter {
|
||||
/**
|
||||
* The current dispatcher
|
||||
* @type {?StreamDispatcher}
|
||||
* @readonly
|
||||
*/
|
||||
get currentDispatcher() {
|
||||
return this.streams.size > 0 ? this.streams.last().dispatcher || null : null;
|
||||
|
||||
Reference in New Issue
Block a user