From 231bb4cf1cdc2a88c9a30e62b79c95372cf03761 Mon Sep 17 00:00:00 2001 From: Jaw0r3k Date: Mon, 28 Nov 2022 16:23:36 +0100 Subject: [PATCH 1/4] feat: describe private properties --- packages/discord.js/src/managers/CachedManager.js | 7 +++++++ packages/discord.js/src/structures/GuildMember.js | 5 +++++ packages/discord.js/src/structures/Presence.js | 14 ++++++++++++++ packages/discord.js/typings/index.d.ts | 4 ++++ 4 files changed, 30 insertions(+) diff --git a/packages/discord.js/src/managers/CachedManager.js b/packages/discord.js/src/managers/CachedManager.js index 1058285d300e..e0ce0f8a52ca 100644 --- a/packages/discord.js/src/managers/CachedManager.js +++ b/packages/discord.js/src/managers/CachedManager.js @@ -11,6 +11,13 @@ class CachedManager extends DataManager { constructor(client, holds, iterable) { super(client, holds); + /** + * The private cache of items for this manager. + * @type {Collection} + * @private + * @readonly + * @name CachedManager#_cache + */ Object.defineProperty(this, '_cache', { value: this.client.options.makeCache(this.constructor, this.holds) }); if (iterable) { diff --git a/packages/discord.js/src/structures/GuildMember.js b/packages/discord.js/src/structures/GuildMember.js index 8553889f33bb..eef3dcb48bc8 100644 --- a/packages/discord.js/src/structures/GuildMember.js +++ b/packages/discord.js/src/structures/GuildMember.js @@ -53,6 +53,11 @@ class GuildMember extends Base { */ this.communicationDisabledUntilTimestamp = null; + /** + * The role ids of this member + * @type {Snowflake[]} + * @private + */ this._roles = []; if (data) this._patch(data); } diff --git a/packages/discord.js/src/structures/Presence.js b/packages/discord.js/src/structures/Presence.js index 825bc01029de..1e9e50134372 100644 --- a/packages/discord.js/src/structures/Presence.js +++ b/packages/discord.js/src/structures/Presence.js @@ -141,6 +141,13 @@ class Presence extends Base { */ class Activity { constructor(presence, data) { + /** + * The presence of the Activity + * @type {Presence} + * @private + * @readonly + * @name Activity#presence + */ Object.defineProperty(this, 'presence', { value: presence }); /** @@ -285,6 +292,13 @@ class Activity { */ class RichPresenceAssets { constructor(activity, assets) { + /** + * The activity of the RichPresenceAssets + * @type {Activity} + * @private + * @readonly + * @name RichPresenceAssets#activity + */ Object.defineProperty(this, 'activity', { value: activity }); /** diff --git a/packages/discord.js/typings/index.d.ts b/packages/discord.js/typings/index.d.ts index eaa6e83bad87..c91dcc2bed29 100644 --- a/packages/discord.js/typings/index.d.ts +++ b/packages/discord.js/typings/index.d.ts @@ -227,6 +227,7 @@ declare module 'node:events' { export class Activity { private constructor(presence: Presence, data?: RawActivityData); + private readonly presence: Presence; public applicationId: Snowflake | null; public assets: RichPresenceAssets | null; public buttons: string[]; @@ -1417,6 +1418,7 @@ export class GuildEmoji extends BaseGuildEmoji { export class GuildMember extends PartialTextBasedChannel(Base) { private constructor(client: Client, data: RawGuildMemberData, guild: Guild); + private _roles: Snowflake[]; public avatar: string | null; public get bannable(): boolean; public get dmChannel(): DMChannel | null; @@ -2348,6 +2350,7 @@ export class ReactionEmoji extends Emoji { export class RichPresenceAssets { private constructor(activity: Activity, assets: RawRichPresenceAssets); + private readonly activity: Activity; public largeImage: Snowflake | null; public largeText: string | null; public smallImage: Snowflake | null; @@ -3577,6 +3580,7 @@ export abstract class DataManager extends BaseManager { export abstract class CachedManager extends DataManager { protected constructor(client: Client, holds: Constructable); + private readonly _cache: Collection; private _add(data: unknown, cache?: boolean, { id, extras }?: { id: K; extras: unknown[] }): Holds; } From bac975f974ca634489b90e34d12cdd6784c78d6f Mon Sep 17 00:00:00 2001 From: Jaworek Date: Mon, 28 Nov 2022 18:23:12 +0100 Subject: [PATCH 2/4] Update packages/discord.js/src/structures/GuildMember.js Co-authored-by: MrMythicalYT <91077061+MrMythicalYT@users.noreply.github.com> --- packages/discord.js/src/structures/GuildMember.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/discord.js/src/structures/GuildMember.js b/packages/discord.js/src/structures/GuildMember.js index eef3dcb48bc8..c7c92d1d267a 100644 --- a/packages/discord.js/src/structures/GuildMember.js +++ b/packages/discord.js/src/structures/GuildMember.js @@ -54,7 +54,7 @@ class GuildMember extends Base { this.communicationDisabledUntilTimestamp = null; /** - * The role ids of this member + * The role ids of the member * @type {Snowflake[]} * @private */ From 63614ce8111ba0e1c60e2d5692dabeaefc757a19 Mon Sep 17 00:00:00 2001 From: Jaworek Date: Mon, 28 Nov 2022 18:26:49 +0100 Subject: [PATCH 3/4] Apply suggestions from code review Co-authored-by: MrMythicalYT <91077061+MrMythicalYT@users.noreply.github.com> --- packages/discord.js/src/structures/Presence.js | 2 -- 1 file changed, 2 deletions(-) diff --git a/packages/discord.js/src/structures/Presence.js b/packages/discord.js/src/structures/Presence.js index 1e9e50134372..69c40f65c892 100644 --- a/packages/discord.js/src/structures/Presence.js +++ b/packages/discord.js/src/structures/Presence.js @@ -144,7 +144,6 @@ class Activity { /** * The presence of the Activity * @type {Presence} - * @private * @readonly * @name Activity#presence */ @@ -295,7 +294,6 @@ class RichPresenceAssets { /** * The activity of the RichPresenceAssets * @type {Activity} - * @private * @readonly * @name RichPresenceAssets#activity */ From 864ab4647e950cdbff6df9462df5da1eec4a9ac0 Mon Sep 17 00:00:00 2001 From: Jaworek Date: Mon, 28 Nov 2022 18:27:59 +0100 Subject: [PATCH 4/4] Apply suggestions from code review --- packages/discord.js/typings/index.d.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/discord.js/typings/index.d.ts b/packages/discord.js/typings/index.d.ts index c91dcc2bed29..5af919ca9d3b 100644 --- a/packages/discord.js/typings/index.d.ts +++ b/packages/discord.js/typings/index.d.ts @@ -227,7 +227,7 @@ declare module 'node:events' { export class Activity { private constructor(presence: Presence, data?: RawActivityData); - private readonly presence: Presence; + public readonly presence: Presence; public applicationId: Snowflake | null; public assets: RichPresenceAssets | null; public buttons: string[]; @@ -2350,7 +2350,7 @@ export class ReactionEmoji extends Emoji { export class RichPresenceAssets { private constructor(activity: Activity, assets: RawRichPresenceAssets); - private readonly activity: Activity; + public readonly activity: Activity; public largeImage: Snowflake | null; public largeText: string | null; public smallImage: Snowflake | null;