From 928fb300407bf3aea98905708144dc7138035dd9 Mon Sep 17 00:00:00 2001 From: Isabella Date: Tue, 21 Aug 2018 14:25:30 -0500 Subject: [PATCH] fix: actually fix Readonly typos --- src/client/voice/VoiceConnection.js | 8 ++++---- src/structures/GuildChannel.js | 4 ++-- src/structures/GuildMember.js | 4 ++-- src/structures/PermissionOverwrites.js | 4 ++-- src/structures/Presence.js | 2 +- src/structures/Role.js | 4 ++-- src/util/BitField.js | 2 +- 7 files changed, 14 insertions(+), 14 deletions(-) diff --git a/src/client/voice/VoiceConnection.js b/src/client/voice/VoiceConnection.js index eeaf768d0..6e0557995 100644 --- a/src/client/voice/VoiceConnection.js +++ b/src/client/voice/VoiceConnection.js @@ -51,7 +51,7 @@ class VoiceConnection extends EventEmitter { /** * Our current speaking state - * @type {ReadOnly} + * @type {Readonly} */ this.speaking = new Speaking().freeze(); @@ -97,7 +97,7 @@ class VoiceConnection extends EventEmitter { /** * Tracks which users are talking - * @type {Map>} + * @type {Map>} * @private */ this._speaking = new Map(); @@ -443,7 +443,7 @@ class VoiceConnection extends EventEmitter { * Emitted whenever a user changes speaking state. * @event VoiceConnection#speaking * @param {User} user The user that has changed speaking state - * @param {ReadOnly} speaking The speaking state of the user + * @param {Readonly} speaking The speaking state of the user */ if (this.status === VoiceStatus.CONNECTED) { this.emit('speaking', user, speaking); @@ -459,7 +459,7 @@ class VoiceConnection extends EventEmitter { * Emitted once a guild member changes speaking state. * @event Client#guildMemberSpeaking * @param {GuildMember} member The member that started/stopped speaking - * @param {ReadOnly} speaking The speaking state of the member + * @param {Readonly} speaking The speaking state of the member */ this.client.emit(Events.GUILD_MEMBER_SPEAKING, member, speaking); } diff --git a/src/structures/GuildChannel.js b/src/structures/GuildChannel.js index b64eca976..20e09093f 100644 --- a/src/structures/GuildChannel.js +++ b/src/structures/GuildChannel.js @@ -133,7 +133,7 @@ class GuildChannel extends Channel { /** * Gets the overall set of permissions for a member in this channel, taking into account channel overwrites. * @param {GuildMember} member The member to obtain the overall permissions for - * @returns {ReadOnly} + * @returns {Readonly} * @private */ memberPermissions(member) { @@ -159,7 +159,7 @@ class GuildChannel extends Channel { /** * Gets the overall set of permissions for a role in this channel, taking into account channel overwrites. * @param {Role} role The role to obtain the overall permissions for - * @returns {ReadOnly} + * @returns {Readonly} * @private */ rolePermissions(role) { diff --git a/src/structures/GuildMember.js b/src/structures/GuildMember.js index de42e354c..d910117d3 100644 --- a/src/structures/GuildMember.js +++ b/src/structures/GuildMember.js @@ -168,7 +168,7 @@ class GuildMember extends Base { /** * The overall set of permissions for this member, taking only roles into account - * @type {ReadOnly} + * @type {Readonly} * @readonly */ get permissions() { @@ -209,7 +209,7 @@ class GuildMember extends Base { * Returns `channel.permissionsFor(guildMember)`. Returns permissions for a member in a guild channel, * taking into account roles and permission overwrites. * @param {ChannelResolvable} channel The guild channel to use as context - * @returns {ReadOnly} + * @returns {Readonly} */ permissionsIn(channel) { channel = this.guild.channels.resolve(channel); diff --git a/src/structures/PermissionOverwrites.js b/src/structures/PermissionOverwrites.js index f2ece7ced..ddf9c4208 100644 --- a/src/structures/PermissionOverwrites.js +++ b/src/structures/PermissionOverwrites.js @@ -39,13 +39,13 @@ class PermissionOverwrites { /** * The permissions that are denied for the user or role. - * @type {ReadOnly} + * @type {Readonly} */ this.deny = new Permissions(data.deny).freeze(); /** * The permissions that are allowed for the user or role. - * @type {ReadOnly} + * @type {Readonly} */ this.allow = new Permissions(data.allow).freeze(); } diff --git a/src/structures/Presence.js b/src/structures/Presence.js index 0c5cdc191..339981340 100644 --- a/src/structures/Presence.js +++ b/src/structures/Presence.js @@ -154,7 +154,7 @@ class Activity { /** * Flags that describe the activity - * @type {ReadOnly} + * @type {Readonly} */ this.flags = new ActivityFlags(data.flags).freeze(); } diff --git a/src/structures/Role.js b/src/structures/Role.js index e6808a822..18f68f2f9 100644 --- a/src/structures/Role.js +++ b/src/structures/Role.js @@ -54,7 +54,7 @@ class Role extends Base { /** * The permissions of the role - * @type {ReadOnly} + * @type {Readonly} */ this.permissions = new Permissions(data.permissions).freeze(); @@ -203,7 +203,7 @@ class Role extends Base { * Returns `channel.permissionsFor(role)`. Returns permissions for a role in a guild channel, * taking into account permission overwrites. * @param {ChannelResolvable} channel The guild channel to use as context - * @returns {ReadOnly} + * @returns {Readonly} */ permissionsIn(channel) { channel = this.guild.channels.resolve(channel); diff --git a/src/util/BitField.js b/src/util/BitField.js index 2cd9c907a..fa506a2e8 100644 --- a/src/util/BitField.js +++ b/src/util/BitField.js @@ -48,7 +48,7 @@ class BitField { /** * Freezes these bits, making them immutable. - * @returns {ReadOnly} These bits + * @returns {Readonly} These bits */ freeze() { return Object.freeze(this);