Skip to content

Commit

Permalink
docs: again
Browse files Browse the repository at this point in the history
  • Loading branch information
@almeidx
almeidx committed Feb 21, 2025
1 parent 3abc1f9 commit f6f381c
Show file tree
Hide file tree
Showing 38 changed files with 140 additions and 116 deletions.
22 changes: 11 additions & 11 deletions deno/gateway/v10.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -847,13 +847,13 @@ export interface GatewayGuildCreateDispatchData extends APIGuild {
/**
* When this guild was joined at
*
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
*/
joined_at: string;
/**
* `true` if this is considered a large guild
*
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
*/
large: boolean;
/**
Expand All @@ -863,69 +863,69 @@ export interface GatewayGuildCreateDispatchData extends APIGuild {
/**
* Total number of members in this guild
*
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
*/
member_count: number;
/**
* States of members currently in voice channels; lacks the `guild_id` key
*
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
*
* @see {@link https://discord.com/developers/docs/resources/voice#voice-state-object}
*/
voice_states: Omit<APIVoiceState, 'guild_id'>[];
/**
* Users in the guild
*
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
*
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
*/
members: APIGuildMember[];
/**
* Channels in the guild
*
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
*
* @see {@link https://discord.com/developers/docs/resources/channel#channel-object}
*/
channels: (APIChannel & { type: Exclude<GuildChannelType, ThreadChannelType> })[];
/**
* Threads in the guild
*
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
*
* @see {@link https://discord.com/developers/docs/resources/channel#channel-object}
*/
threads: (APIChannel & { type: ThreadChannelType })[];
/**
* Presences of the members in the guild, will only include non-offline members if the size is greater than `large_threshold`
*
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
*
* @see {@link https://discord.com/developers/docs/topics/gateway-events#presence-update}
*/
presences: GatewayPresenceUpdate[];
/**
* The stage instances in the guild
*
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
*
* @see {@link https://discord.com/developers/docs/resources/stage-instance#stage-instance-object-stage-instance-structure}
*/
stage_instances: APIStageInstance[];
/**
* The scheduled events in the guild
*
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
*
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object}
*/
guild_scheduled_events: APIGuildScheduledEvent[];
/**
* The soundboard sounds in the guild
*
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
*
* @see {@link https://discord.com/developers/docs/resources/soundboard#soundboard-sound-object}
*/
Expand Down
22 changes: 11 additions & 11 deletions deno/gateway/v9.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -846,13 +846,13 @@ export interface GatewayGuildCreateDispatchData extends APIGuild {
/**
* When this guild was joined at
*
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
*/
joined_at: string;
/**
* `true` if this is considered a large guild
*
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
*/
large: boolean;
/**
Expand All @@ -862,69 +862,69 @@ export interface GatewayGuildCreateDispatchData extends APIGuild {
/**
* Total number of members in this guild
*
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
*/
member_count: number;
/**
* States of members currently in voice channels; lacks the `guild_id` key
*
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
*
* @see {@link https://discord.com/developers/docs/resources/voice#voice-state-object}
*/
voice_states: Omit<APIVoiceState, 'guild_id'>[];
/**
* Users in the guild
*
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
*
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
*/
members: APIGuildMember[];
/**
* Channels in the guild
*
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
*
* @see {@link https://discord.com/developers/docs/resources/channel#channel-object}
*/
channels: (APIChannel & { type: Exclude<GuildChannelType, ThreadChannelType> })[];
/**
* Threads in the guild
*
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
*
* @see {@link https://discord.com/developers/docs/resources/channel#channel-object}
*/
threads: (APIChannel & { type: ThreadChannelType })[];
/**
* Presences of the members in the guild, will only include non-offline members if the size is greater than `large_threshold`
*
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
*
* @see {@link https://discord.com/developers/docs/topics/gateway-events#presence-update}
*/
presences: GatewayPresenceUpdate[];
/**
* The stage instances in the guild
*
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
*
* @see {@link https://discord.com/developers/docs/resources/stage-instance#stage-instance-object-stage-instance-structure}
*/
stage_instances: APIStageInstance[];
/**
* The scheduled events in the guild
*
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
*
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object}
*/
guild_scheduled_events: APIGuildScheduledEvent[];
/**
* The soundboard sounds in the guild
*
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
*
* @see {@link https://discord.com/developers/docs/resources/soundboard#soundboard-sound-object}
*/
Expand Down
10 changes: 5 additions & 5 deletions deno/payloads/v10/application.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -209,13 +209,13 @@ export enum ApplicationFlags {
/**
* 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`](https://discord.com/developers/docs/topics/gateway#list-of-intents)
* @see List of member-related events {@link https://discord.com/developers/docs/topics/gateway#list-of-intents | under `GUILD_MEMBERS`}
*/
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`](https://discord.com/developers/docs/topics/gateway#list-of-intents)
* @see List of member-related events {@link https://discord.com/developers/docs/topics/gateway#list-of-intents | under `GUILD_MEMBERS`}
*/
GatewayGuildMembersLimited = 1 << 15,
/**
Expand All @@ -227,11 +227,11 @@ export enum ApplicationFlags {
*/
Embedded = 1 << 17,
/**
* Intent required for bots in 100 or more servers to receive [message content](https://support-dev.discord.com/hc/en-us/articles/4404772028055)
* Intent required for bots in 100 or more servers to receive {@link https://support-dev.discord.com/hc/en-us/articles/4404772028055 | message content}
*/
GatewayMessageContent = 1 << 18,
/**
* Intent required for bots in under 100 servers to receive [message content](https://support-dev.discord.com/hc/en-us/articles/4404772028055),
* Intent required for bots in under 100 servers to receive {@link https://support-dev.discord.com/hc/en-us/articles/4404772028055 | message content},
* found in Bot Settings
*/
GatewayMessageContentLimited = 1 << 19,
Expand All @@ -240,7 +240,7 @@ export enum ApplicationFlags {
*/
EmbeddedFirstParty = 1 << 20,
/**
* Indicates if an app has registered global [application commands](https://discord.com/developers/docs/interactions/application-commands)
* Indicates if an app has registered global {@link https://discord.com/developers/docs/interactions/application-commands | application commands}
*/
ApplicationCommandBadge = 1 << 23,
}
Expand Down
1 change: 1 addition & 0 deletions deno/payloads/v10/guild.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -741,6 +741,7 @@ export enum GuildMemberFlags {
AutomodQuarantinedUsernameOrGuildNickname = 1 << 7,
/**
* @deprecated
* {@link https://github.com/discord/discord-api-docs/pull/7113 | discord-api-docs#7113}
*/
AutomodQuarantinedBio = 1 << 8,
/**
Expand Down
1 change: 1 addition & 0 deletions deno/payloads/v10/invite.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ export interface APIInvite {
* The stage instance data if there is a public stage instance in the stage channel this invite is for
*
* @deprecated
* {@link https://github.com/discord/discord-api-docs/pull/4479 | discord-api-docs#4479}
*/
stage_instance?: APIInviteStageInstance;
/**
Expand Down
10 changes: 5 additions & 5 deletions deno/payloads/v10/oauth2.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export enum OAuth2Scopes {
*/
Bot = 'bot',
/**
* Allows [/users/\@me/connections](https://discord.com/developers/docs/resources/user#get-user-connections)
* Allows {@link https://discord.com/developers/docs/resources/user#get-user-connections | `/users/@me/connections`}
* to return linked third-party accounts
*
* @see {@link https://discord.com/developers/docs/resources/user#get-user-connections}
Expand All @@ -19,26 +19,26 @@ export enum OAuth2Scopes {
*/
DMChannelsRead = 'dm_channels.read',
/**
* Enables [/users/\@me](https://discord.com/developers/docs/resources/user#get-current-user) to return an `email`
* Enables {@link https://discord.com/developers/docs/resources/user#get-current-user | `/users/@me`} to return an `email`
*
* @see {@link https://discord.com/developers/docs/resources/user#get-current-user}
*/
Email = 'email',
/**
* Allows [/users/\@me](https://discord.com/developers/docs/resources/user#get-current-user) without `email`
* Allows {@link https://discord.com/developers/docs/resources/user#get-current-user | `/users/@me`} without `email`
*
* @see {@link https://discord.com/developers/docs/resources/user#get-current-user}
*/
Identify = 'identify',
/**
* Allows [/users/\@me/guilds](https://discord.com/developers/docs/resources/user#get-current-user-guilds)
* Allows {@link https://discord.com/developers/docs/resources/user#get-current-user-guilds | `/users/@me/guilds`}
* to return basic information about all of a user's guilds
*
* @see {@link https://discord.com/developers/docs/resources/user#get-current-user-guilds}
*/
Guilds = 'guilds',
/**
* Allows [/guilds/\{guild.id\}/members/\{user.id\}](https://discord.com/developers/docs/resources/guild#add-guild-member)
* Allows {@link https://discord.com/developers/docs/resources/guild#add-guild-member | `/guilds/[guild.id]/members/[user.id]`}
* to be used for joining users to a guild
*
* @see {@link https://discord.com/developers/docs/resources/guild#add-guild-member}
Expand Down
5 changes: 5 additions & 0 deletions deno/payloads/v10/stageInstance.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ export interface APIStageInstance {
* Whether or not stage discovery is disabled
*
* @deprecated
* {@link https://github.com/discord/discord-api-docs/pull/4296 | discord-api-docs#4296}
*/
discoverable_disabled: boolean;
/**
Expand All @@ -47,6 +48,7 @@ export enum StageInstancePrivacyLevel {
* The stage instance is visible publicly, such as on stage discovery
*
* @deprecated
* {@link https://github.com/discord/discord-api-docs/pull/4296 | discord-api-docs#4296}
*/
Public = 1,
/**
Expand All @@ -57,6 +59,9 @@ export enum StageInstancePrivacyLevel {

/**
* https://discord.com/developers/docs/resources/invite#invite-stage-instance-object-invite-stage-instance-structure
*
* @deprecated
* {@link https://github.com/discord/discord-api-docs/pull/4479 | discord-api-docs#4479}
*/
export interface APIInviteStageInstance {
/**
Expand Down
8 changes: 4 additions & 4 deletions deno/payloads/v10/user.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ export enum UserFlags {
*/
PremiumEarlySupporter = 1 << 9,
/**
* User is a [team](https://discord.com/developers/docs/topics/teams)
* User is a {@link https://discord.com/developers/docs/topics/teams | team}
*/
TeamPseudoUser = 1 << 10,
/**
Expand All @@ -167,7 +167,7 @@ export enum UserFlags {
*/
CertifiedModerator = 1 << 18,
/**
* Bot uses only [HTTP interactions](https://discord.com/developers/docs/interactions/receiving-and-responding#receiving-an-interaction) and is shown in the online member list
* Bot uses only {@link https://discord.com/developers/docs/interactions/receiving-and-responding#receiving-an-interaction | HTTP interactions} and is shown in the online member list
*/
BotHTTPInteractions = 1 << 19,
/**
Expand All @@ -181,11 +181,11 @@ export enum UserFlags {
*/
DisablePremium = 1 << 21,
/**
* User is an [Active Developer](https://support-dev.discord.com/hc/articles/10113997751447)
* User is an {@link https://support-dev.discord.com/hc/articles/10113997751447 | Active Developer}
*/
ActiveDeveloper = 1 << 22,
/**
* User's account has been [quarantined](https://support.discord.com/hc/articles/6461420677527) based on recent activity
* User's account has been {@link https://support.discord.com/hc/articles/6461420677527 | quarantined} based on recent activity
*
* @unstable This user flag is currently not documented by Discord but has a known value which we will try to keep up to date.
* @privateRemarks
Expand Down
10 changes: 5 additions & 5 deletions deno/payloads/v9/application.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -209,13 +209,13 @@ export enum ApplicationFlags {
/**
* 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`](https://discord.com/developers/docs/topics/gateway#list-of-intents)
* @see List of member-related events {@link https://discord.com/developers/docs/topics/gateway#list-of-intents | under `GUILD_MEMBERS`}
*/
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`](https://discord.com/developers/docs/topics/gateway#list-of-intents)
* @see List of member-related events {@link https://discord.com/developers/docs/topics/gateway#list-of-intents | under `GUILD_MEMBERS`}
*/
GatewayGuildMembersLimited = 1 << 15,
/**
Expand All @@ -227,11 +227,11 @@ export enum ApplicationFlags {
*/
Embedded = 1 << 17,
/**
* Intent required for bots in 100 or more servers to receive [message content](https://support-dev.discord.com/hc/en-us/articles/4404772028055)
* Intent required for bots in 100 or more servers to receive {@link https://support-dev.discord.com/hc/en-us/articles/4404772028055 | message content}
*/
GatewayMessageContent = 1 << 18,
/**
* Intent required for bots in under 100 servers to receive [message content](https://support-dev.discord.com/hc/en-us/articles/4404772028055),
* Intent required for bots in under 100 servers to receive {@link https://support-dev.discord.com/hc/en-us/articles/4404772028055 | message content},
* found in Bot Settings
*/
GatewayMessageContentLimited = 1 << 19,
Expand All @@ -240,7 +240,7 @@ export enum ApplicationFlags {
*/
EmbeddedFirstParty = 1 << 20,
/**
* Indicates if an app has registered global [application commands](https://discord.com/developers/docs/interactions/application-commands)
* Indicates if an app has registered global {@link https://discord.com/developers/docs/interactions/application-commands | application commands}
*/
ApplicationCommandBadge = 1 << 23,
}
Expand Down
1 change: 1 addition & 0 deletions deno/payloads/v9/guild.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -733,6 +733,7 @@ export enum GuildMemberFlags {
AutomodQuarantinedUsernameOrGuildNickname = 1 << 7,
/**
* @deprecated
* {@link https://github.com/discord/discord-api-docs/pull/7113 | discord-api-docs#7113}
*/
AutomodQuarantinedBio = 1 << 8,
/**
Expand Down
1 change: 1 addition & 0 deletions deno/payloads/v9/invite.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ export interface APIInvite {
* The stage instance data if there is a public stage instance in the stage channel this invite is for
*
* @deprecated
* {@link https://github.com/discord/discord-api-docs/pull/4479 | discord-api-docs#4479}
*/
stage_instance?: APIInviteStageInstance;
/**
Expand Down
Loading

0 comments on commit f6f381c

Please sign in to comment.