Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-19 13:03:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Fix malformed overridden documentation (#8954)

Browse Source 
* docs: override `resolve()` & `resolveId()`

* docs(CategoryChannel): move `setParent()` up

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
This commit is contained in:
Jiralite
2022-12-24 07:35:32 +00:00
committed by GitHub
parent 6614603326
commit 0b8b114761
2 changed files with 27 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
packages/discord.js/src/managers/AutoModerationRuleManager.js
View File

@@ -26,6 +26,24 @@ class AutoModerationRuleManager extends CachedManager {
* @name AutoModerationRuleManager#cache * @name AutoModerationRuleManager#cache
*/ */
/**
* Resolves an {@link AutoModerationRuleResolvable} to an {@link AutoModerationRule} object.
* @method resolve
* @memberof AutoModerationRuleManager
* @instance
* @param {AutoModerationRuleResolvable} autoModerationRule The AutoModerationRule resolvable to resolve
* @returns {?AutoModerationRule}
*/
/**
* Resolves an {@link AutoModerationRuleResolvable} to a {@link AutoModerationRule} id.
* @method resolveId
* @memberof AutoModerationRuleManager
* @instance
* @param {AutoModerationRuleResolvable} autoModerationRule The AutoModerationRule resolvable to resolve
* @returns {?Snowflake}
*/
_add(data, cache) { _add(data, cache) {
return super._add(data, cache, { extras: [this.guild] }); return super._add(data, cache, { extras: [this.guild] });
} }
@@ -259,24 +277,6 @@ class AutoModerationRuleManager extends CachedManager {
const autoModerationRuleId = this.resolveId(autoModerationRule); const autoModerationRuleId = this.resolveId(autoModerationRule);
await this.client.rest.delete(Routes.guildAutoModerationRule(this.guild.id, autoModerationRuleId), { reason }); await this.client.rest.delete(Routes.guildAutoModerationRule(this.guild.id, autoModerationRuleId), { reason });
} }
/**
* Resolves an {@link AutoModerationRuleResolvable} to an {@link AutoModerationRule} object.
* @method resolve
* @memberof AutoModerationRuleManager
* @instance
* @param {AutoModerationRuleResolvable} autoModerationRule The AutoModerationRule resolvable to resolve
* @returns {?AutoModerationRule}
*/
/**
* Resolves an {@link AutoModerationRuleResolvable} to a {@link AutoModerationRule} id.
* @method resolveId
* @memberof AutoModerationRuleManager
* @instance
* @param {AutoModerationRuleResolvable} autoModerationRule The AutoModerationRule resolvable to resolve
* @returns {?Snowflake}
*/
} }
module.exports = AutoModerationRuleManager; module.exports = AutoModerationRuleManager;

18
packages/discord.js/src/structures/CategoryChannel.js
View File

@@ -8,15 +8,6 @@ const CategoryChannelChildManager = require('../managers/CategoryChannelChildMan
* @extends {GuildChannel} * @extends {GuildChannel}
*/ */
class CategoryChannel extends GuildChannel { class CategoryChannel extends GuildChannel {
/**
* A manager of the channels belonging to this category
* @type {CategoryChannelChildManager}
* @readonly
*/
get children() {
return new CategoryChannelChildManager(this);
}
/** /**
* Sets the category parent of this channel. * Sets the category parent of this channel.
* <warn>It is not currently possible to set the parent of a CategoryChannel.</warn> * <warn>It is not currently possible to set the parent of a CategoryChannel.</warn>
@@ -27,6 +18,15 @@ class CategoryChannel extends GuildChannel {
* @param {SetParentOptions} [options={}] The options for setting the parent * @param {SetParentOptions} [options={}] The options for setting the parent
* @returns {Promise<GuildChannel>} * @returns {Promise<GuildChannel>}
*/ */
/**
* A manager of the channels belonging to this category
* @type {CategoryChannelChildManager}
* @readonly
*/
get children() {
return new CategoryChannelChildManager(this);
}
} }
module.exports = CategoryChannel; module.exports = CategoryChannel;