mirror of
https://github.com/discordeno/discordeno.git
synced 2026-09-17 08:47:22 +00:00
fix(website): Fix docusaurus build/typedoc warnings (#3929)
* Fix docusaurus build/typedoc warnings * include the jsdoc fixes
This commit is contained in:
@@ -1186,7 +1186,6 @@ export interface RestManager {
|
||||
* Edits a guild's settings.
|
||||
*
|
||||
* @param guildId - The ID of the guild to edit.
|
||||
* @param shardId - The ID of the shard the guild is in.
|
||||
* @param options - The parameters for the edit of the guild.
|
||||
* @param {string} [reason] - An optional reason for the action, to be included in the audit log.
|
||||
* @returns An instance of the edited {@link CamelizedDiscordGuild}.
|
||||
@@ -2177,7 +2176,7 @@ export interface RestManager {
|
||||
* Gets a role by id for a guild.
|
||||
*
|
||||
* @param guildId - The ID of the guild to get role for.
|
||||
* @param roleID - The ID of the role.
|
||||
* @param roleId - The ID of the role.
|
||||
* @returns A {@link CamelizedDiscordRole} object.
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/resources/guild#get-guild-role}
|
||||
@@ -2989,7 +2988,7 @@ export interface RestManager {
|
||||
*
|
||||
* Onboarding enforces constraints when enabled. These constraints are:
|
||||
* - at least 7 default channels
|
||||
* - at least 5 of the 7 channels must allow sending messages to the @everyone role
|
||||
* - at least 5 of the 7 channels must allow sending messages to the \@everyone role
|
||||
*
|
||||
* The `mode` field modifies what is considered when enforcing these constraints.
|
||||
*/
|
||||
|
||||
@@ -1482,14 +1482,14 @@ export enum DiscordMessageReferenceType {
|
||||
* A standard reference used by replies.
|
||||
*
|
||||
* @remarks
|
||||
* When the type is set to this value, the field {@link DiscordMessage.referenced_message} will be present
|
||||
* When the type is set to this value, the field referenced_message on the message will be present
|
||||
*/
|
||||
Default,
|
||||
/**
|
||||
* Reference used to point to a message at a point in time.
|
||||
*
|
||||
* @remarks
|
||||
* When the type is set to this value, the field {@link DiscordMessage.message_snapshot} will be present in the
|
||||
* When the type is set to this value, the field message_snapshot on the message will be present
|
||||
*
|
||||
* This value can only be used for basic messages;
|
||||
* i.e. messages which do not have strong bindings to a non global entity.
|
||||
|
||||
@@ -1013,7 +1013,7 @@ export interface CreateStageInstance {
|
||||
channelId: BigString
|
||||
/** The topic of the Stage instance (1-120 characters) */
|
||||
topic: string
|
||||
/** Notify @everyone that the stage instance has started. Requires the MENTION_EVERYONE permission. */
|
||||
/** Notify \@everyone that the stage instance has started. Requires the MENTION_EVERYONE permission. */
|
||||
sendStartNotification?: boolean
|
||||
/** The guild scheduled event associated with this Stage instance */
|
||||
guildScheduledEventId?: BigString
|
||||
|
||||
@@ -184,13 +184,13 @@ export enum TeamMembershipStates {
|
||||
export enum ApplicationFlags {
|
||||
/** Indicates if an app uses the Auto Moderation API. */
|
||||
ApplicationAutoModerationRuleCreateBadge = 1 << 6,
|
||||
/** Intent required for bots in **100 or more servers** to receive [`presence_update` events](#DOCS_TOPICS_GATEWAY/presence-update) */
|
||||
/** Intent required for bots in **100 or more servers** to receive 'presence_update' events */
|
||||
GatewayPresence = 1 << 12,
|
||||
/** Intent required for bots in under 100 servers to receive [`presence_update` events](#DOCS_TOPICS_GATEWAY/presence-update), found in Bot Settings */
|
||||
/** Intent required for bots in under 100 servers to receive 'presence_update' events */
|
||||
GatewayPresenceLimited = 1 << 13,
|
||||
/** Intent required for bots in **100 or more servers** to receive member-related events like `guild_member_add`. See list of member-related events [under `GUILD_MEMBERS`](#DOCS_TOPICS_GATEWAY/list-of-intents) */
|
||||
/** Intent required for bots in **100 or more servers** to receive member-related events like 'guild_member_add'. */
|
||||
GatewayGuildMembers = 1 << 14,
|
||||
/** Intent required for bots in under 100 servers to receive member-related events like `guild_member_add`, found in Bot Settings. See list of member-related events [under `GUILD_MEMBERS`](#DOCS_TOPICS_GATEWAY/list-of-intents) */
|
||||
/** Intent required for bots in under 100 servers to receive member-related events like 'guild_member_add'. */
|
||||
GatewayGuildMembersLimited = 1 << 15,
|
||||
/** Indicates unusual growth of an app that prevents verification */
|
||||
VerificationPendingGuildLimit = 1 << 16,
|
||||
@@ -253,7 +253,7 @@ export enum AllowedMentionsTypes {
|
||||
RoleMentions = 'roles',
|
||||
/** Controls user mentions */
|
||||
UserMentions = 'users',
|
||||
/** Controls @everyone and @here mentions */
|
||||
/** Controls \@everyone and \@here mentions */
|
||||
EveryoneMentions = 'everyone',
|
||||
}
|
||||
|
||||
@@ -274,7 +274,7 @@ export type EmbedTypes = 'rich' | 'image' | 'video' | 'gifv' | 'article' | 'link
|
||||
export enum DefaultMessageNotificationLevels {
|
||||
/** Members will receive notifications for all messages by default */
|
||||
AllMessages,
|
||||
/** Members will receive notifications only for messages that @mention them by default */
|
||||
/** Members will receive notifications only for messages that \@mention them by default */
|
||||
OnlyMentions,
|
||||
}
|
||||
|
||||
@@ -748,7 +748,7 @@ export const BitwisePermissionFlags = {
|
||||
ATTACH_FILES: 1n << 15n,
|
||||
/** Allows for reading of message history */
|
||||
READ_MESSAGE_HISTORY: 1n << 16n,
|
||||
/** Allows for using the @everyone tag to notify all users in a channel, and the @here tag to notify all online users in a channel */
|
||||
/** Allows for using the \@everyone tag to notify all users in a channel, and the \@here tag to notify all online users in a channel */
|
||||
MENTION_EVERYONE: 1n << 17n,
|
||||
/** Allows the usage of custom emojis from other servers */
|
||||
USE_EXTERNAL_EMOJIS: 1n << 18n,
|
||||
|
||||
@@ -11,10 +11,6 @@ import type {
|
||||
/**
|
||||
* A builder to help create Discord embeds.
|
||||
*
|
||||
* @export
|
||||
* @class EmbedsBuilder
|
||||
* @typedef {EmbedsBuilder}
|
||||
* @extends {Array<DiscordEmbed>}
|
||||
* @example
|
||||
* const embeds = new EmbedBuilder()
|
||||
* .setTitle('My Embed')
|
||||
|
||||
Reference in New Issue
Block a user