Document readonly and private properties (#1338)

src/client/rest/RequestHandlers/RequestHandler.js

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

src/client/voice/VoiceBroadcast.js

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

src/client/voice/dispatcher/StreamDispatcher.js

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

src/client/voice/player/AudioPlayer.js

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

src/structures/Guild.js

@@ -306,6 +306,7 @@ class Guild {
    * Fetches a collection of roles in the current guild sorted by position.
    * @type {Collection<Snowflake, Role>}
    * @readonly
+   * @private
    */
   get _sortedRoles() {
     return this._sortPositionWithID(this.roles);
@@ -963,6 +964,7 @@ class Guild {
    * Fetches a collection of channels in the current guild sorted by position.
    * @param {string} type Channel type
    * @returns {Collection<Snowflake, GuildChannel>}
+   * @private
    */
   _sortedChannels(type) {
     return this._sortPositionWithID(this.channels.filter(c => {
@@ -977,6 +979,7 @@ class Guild {
    * Intended to be identical to Discord's sorting method.
    * @param {Collection} collection The collection to sort
    * @returns {Collection}
+   * @private
    */
   _sortPositionWithID(collection) {
     return collection.sort((a, b) =>

src/structures/GuildChannel.js

@@ -49,6 +49,7 @@ class GuildChannel extends Channel {
   /**
    * The position of the channel
    * @type {number}
+   * @readonly
    */
   get calculatedPosition() {
     const sorted = this.guild._sortedChannels(this.type);

src/structures/MessageEmbed.js

@@ -105,6 +105,7 @@ class MessageEmbed {
   /**
    * The date this embed was created
    * @type {Date}
+   * @readonly
    */
   get createdAt() {
     return new Date(this.createdTimestamp);

src/structures/MessageReaction.js

@@ -39,6 +39,7 @@ class MessageReaction {
    * object which has fewer properties. Whatever the prototype of the emoji, it will still have
    * `name`, `id`, `identifier` and `toString()`
    * @type {Emoji|ReactionEmoji}
+   * @readonly
    */
   get emoji() {
     if (this._emoji instanceof Emoji) return this._emoji;

src/structures/Role.js

@@ -126,6 +126,7 @@ class Role {
   /**
    * The position of the role in the role manager
    * @type {number}
+   * @readonly
    */
   get calculatedPosition() {
     const sorted = this.guild._sortedRoles;

src/structures/User.js

@@ -175,6 +175,7 @@ class User {
   /**
    * The DM between the client's user and this user
    * @type {?DMChannel}
+   * @readonly
    */
   get dmChannel() {
     return this.client.channels.filter(c => c.type === 'dm').find(c => c.recipient.id === this.id);

src/structures/VoiceChannel.js

@@ -48,6 +48,7 @@ class VoiceChannel extends GuildChannel {
   /**
    * Checks if the voice channel is full
    * @type {boolean}
+   * @readonly
    */
   get full() {
     return this.userLimit > 0 && this.members.size >= this.userLimit;
@@ -56,6 +57,7 @@ class VoiceChannel extends GuildChannel {
   /**
    * Checks if the client has permission join the voice channel
    * @type {boolean}
+   * @readonly
    */
   get joinable() {
     if (this.client.browser) return false;
@@ -67,6 +69,7 @@ class VoiceChannel extends GuildChannel {
   /**
    * Checks if the client has permission to send audio to the voice channel
    * @type {boolean}
+   * @readonly
    */
   get speakable() {
     return this.permissionsFor(this.client.user).hasPermission('SPEAK');

src/util/Permissions.js

@@ -32,6 +32,7 @@ class Permissions {
    * @type {number}
    * @see {@link Permissions#bitfield}
    * @deprecated
+   * @readonly
    */
   get raw() {
     return this.bitfield;