docs: mark getters as @ readonly

This commit is contained in:
SpaceEEC
2019-03-19 19:59:45 +01:00
parent df1889ab49
commit e62833b5e1
15 changed files with 27 additions and 4 deletions

View File

@@ -58,6 +58,7 @@ class VoiceState extends Base {
/**
* The member that this voice state belongs to
* @type {?GuildMember}
* @readonly
*/
get member() {
return this.guild.members.get(this.id) || null;
@@ -66,6 +67,7 @@ class VoiceState extends Base {
/**
* The channel that the member is connected to
* @type {?VoiceChannel}
* @readonly
*/
get channel() {
return this.guild.channels.get(this.channelID) || null;
@@ -74,6 +76,7 @@ class VoiceState extends Base {
/**
* Whether this member is either self-deafened or server-deafened
* @type {?boolean}
* @readonly
*/
get deaf() {
return this.serverDeaf || this.selfDeaf;
@@ -82,6 +85,7 @@ class VoiceState extends Base {
/**
* Whether this member is either self-muted or server-muted
* @type {?boolean}
* @readonly
*/
get mute() {
return this.serverMute || this.selfMute;
@@ -91,6 +95,7 @@ class VoiceState extends Base {
* Whether this member is currently speaking. A boolean if the information is available (aka
* the bot is connected to any voice channel in the guild), otherwise this is null
* @type {?boolean}
* @readonly
*/
get speaking() {
return this.channel && this.channel.connection ?