From 3dd57c2eaf220b08f2b6f6562c34acf8524b5b17 Mon Sep 17 00:00:00 2001 From: Jiralite <33201955+Jiralite@users.noreply.github.com> Date: Fri, 29 Aug 2025 13:53:34 +0400 Subject: [PATCH] docs: Deprecate API related to guild ownership (#11054) * docs: deprecate API usage for guild ownership * docs: remove pointless example --- packages/discord.js/src/managers/GuildManager.js | 1 + packages/discord.js/src/structures/Guild.js | 7 ++----- packages/discord.js/src/structures/GuildTemplate.js | 1 + packages/discord.js/typings/index.d.ts | 7 +++++++ 4 files changed, 11 insertions(+), 5 deletions(-) diff --git a/packages/discord.js/src/managers/GuildManager.js b/packages/discord.js/src/managers/GuildManager.js index 3aa68dae6..58e32af50 100644 --- a/packages/discord.js/src/managers/GuildManager.js +++ b/packages/discord.js/src/managers/GuildManager.js @@ -163,6 +163,7 @@ class GuildManager extends CachedManager { * Creates a guild. * This is only available to bots in fewer than 10 guilds. * @param {GuildCreateOptions} options Options for creating the guild + * @deprecated API related to guild ownership may no longer be used. * @returns {Promise} The guild that was created */ async create({ diff --git a/packages/discord.js/src/structures/Guild.js b/packages/discord.js/src/structures/Guild.js index f664d9709..a4f590270 100644 --- a/packages/discord.js/src/structures/Guild.js +++ b/packages/discord.js/src/structures/Guild.js @@ -1340,11 +1340,7 @@ class Guild extends AnonymousGuild { * @param {GuildMFALevel} level The MFA level * @param {string} [reason] Reason for changing the guild's MFA level * @returns {Promise} - * @example - * // Set the MFA level of the guild to Elevated - * guild.setMFALevel(GuildMFALevel.Elevated) - * .then(guild => console.log("Set guild's MFA level to Elevated")) - * .catch(console.error); + * @deprecated API related to guild ownership may no longer be used. */ async setMFALevel(level, reason) { await this.client.rest.post(Routes.guildMFA(this.id), { @@ -1374,6 +1370,7 @@ class Guild extends AnonymousGuild { /** * Deletes the guild. * @returns {Promise} + * @deprecated API related to guild ownership may no longer be used. * @example * // Delete a guild * guild.delete() diff --git a/packages/discord.js/src/structures/GuildTemplate.js b/packages/discord.js/src/structures/GuildTemplate.js index 7806867b5..a5bcac056 100644 --- a/packages/discord.js/src/structures/GuildTemplate.js +++ b/packages/discord.js/src/structures/GuildTemplate.js @@ -120,6 +120,7 @@ class GuildTemplate extends Base { * @param {string} name The name of the guild * @param {BufferResolvable|Base64Resolvable} [icon] The icon for the guild * @returns {Promise} + * @deprecated API related to guild ownership may no longer be used. */ async createGuild(name, icon) { const { client } = this; diff --git a/packages/discord.js/typings/index.d.ts b/packages/discord.js/typings/index.d.ts index 5f9fbb4e9..8dadb7d18 100644 --- a/packages/discord.js/typings/index.d.ts +++ b/packages/discord.js/typings/index.d.ts @@ -1683,6 +1683,7 @@ export class Guild extends AnonymousGuild { public setVerificationLevel(verificationLevel: GuildVerificationLevel | null, reason?: string): Promise; public setPremiumProgressBarEnabled(enabled?: boolean, reason?: string): Promise; public setWidgetSettings(settings: GuildWidgetSettingsData, reason?: string): Promise; + /** @deprecated API related to guild ownership may no longer be used. */ public setMFALevel(level: GuildMFALevel, reason?: string): Promise; public toJSON(): unknown; } @@ -2021,6 +2022,7 @@ export class GuildTemplate extends Base { public guildId: Snowflake; public serializedGuild: APITemplateSerializedSourceGuild; public unSynced: boolean | null; + /** @deprecated API related to guild ownership may no longer be used. */ public createGuild(name: string, icon?: BufferResolvable | Base64Resolvable): Promise; public delete(): Promise; public edit(options?: GuildTemplateEditOptions): Promise; @@ -4846,6 +4848,7 @@ export interface FetchSoundboardSoundsOptions { export class GuildManager extends CachedManager { private constructor(client: Client, iterable?: Iterable); + /** @deprecated API related to guild ownership may no longer be used. */ public create(options: GuildCreateOptions): Promise; public fetch(options: Snowflake | FetchGuildOptions): Promise; public fetch(options?: FetchGuildsOptions): Promise>; @@ -6646,6 +6649,7 @@ export interface GuildChannelOverwriteOptions { type?: OverwriteType; } +/** @deprecated API related to guild ownership may no longer be used. */ export interface GuildCreateOptions { name: string; icon?: BufferResolvable | Base64Resolvable | null; @@ -7321,6 +7325,7 @@ export interface PresenceData { export type PresenceResolvable = Presence | UserResolvable | Snowflake; +/** @deprecated API related to guild ownership may no longer be used. */ export interface PartialChannelData { id?: Snowflake | number; parentId?: Snowflake | number; @@ -7379,6 +7384,7 @@ export interface PartialThreadMember extends Partialize {} +/** @deprecated API related to guild ownership may no longer be used. */ export interface PartialOverwriteData { id: Snowflake | number; type?: OverwriteType; @@ -7386,6 +7392,7 @@ export interface PartialOverwriteData { deny?: PermissionResolvable; } +/** @deprecated API related to guild ownership may no longer be used. */ export interface PartialRoleData extends RoleData { id?: Snowflake | number; }