Document readonly and private properties (#1338)

This commit is contained in:
SpaceEEC
2017-04-03 20:05:36 +02:00
committed by Crawl
parent 4be08406e6
commit ecb8655dac
12 changed files with 16 additions and 0 deletions

View File

@@ -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;

View File

@@ -42,6 +42,7 @@ class VoiceBroadcast extends VolumeInterface {
/**
* An array of subscribed dispatchers
* @type {StreamDispatcher[]}
* @readonly
*/
get dispatchers() {
let d = [];

View File

@@ -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;

View File

@@ -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;