Skip to content

Commit 585a9ef

Browse files
committed
docs: again
1 parent 3abc1f9 commit 585a9ef

36 files changed

+138
-114
lines changed

deno/gateway/v10.ts

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -847,13 +847,13 @@ export interface GatewayGuildCreateDispatchData extends APIGuild {
847847
/**
848848
* When this guild was joined at
849849
*
850-
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
850+
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
851851
*/
852852
joined_at: string;
853853
/**
854854
* `true` if this is considered a large guild
855855
*
856-
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
856+
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
857857
*/
858858
large: boolean;
859859
/**
@@ -863,69 +863,69 @@ export interface GatewayGuildCreateDispatchData extends APIGuild {
863863
/**
864864
* Total number of members in this guild
865865
*
866-
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
866+
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
867867
*/
868868
member_count: number;
869869
/**
870870
* States of members currently in voice channels; lacks the `guild_id` key
871871
*
872-
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
872+
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
873873
*
874874
* @see {@link https://discord.com/developers/docs/resources/voice#voice-state-object}
875875
*/
876876
voice_states: Omit<APIVoiceState, 'guild_id'>[];
877877
/**
878878
* Users in the guild
879879
*
880-
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
880+
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
881881
*
882882
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
883883
*/
884884
members: APIGuildMember[];
885885
/**
886886
* Channels in the guild
887887
*
888-
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
888+
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
889889
*
890890
* @see {@link https://discord.com/developers/docs/resources/channel#channel-object}
891891
*/
892892
channels: (APIChannel & { type: Exclude<GuildChannelType, ThreadChannelType> })[];
893893
/**
894894
* Threads in the guild
895895
*
896-
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
896+
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
897897
*
898898
* @see {@link https://discord.com/developers/docs/resources/channel#channel-object}
899899
*/
900900
threads: (APIChannel & { type: ThreadChannelType })[];
901901
/**
902902
* Presences of the members in the guild, will only include non-offline members if the size is greater than `large_threshold`
903903
*
904-
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
904+
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
905905
*
906906
* @see {@link https://discord.com/developers/docs/topics/gateway-events#presence-update}
907907
*/
908908
presences: GatewayPresenceUpdate[];
909909
/**
910910
* The stage instances in the guild
911911
*
912-
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
912+
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
913913
*
914914
* @see {@link https://discord.com/developers/docs/resources/stage-instance#stage-instance-object-stage-instance-structure}
915915
*/
916916
stage_instances: APIStageInstance[];
917917
/**
918918
* The scheduled events in the guild
919919
*
920-
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
920+
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
921921
*
922922
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object}
923923
*/
924924
guild_scheduled_events: APIGuildScheduledEvent[];
925925
/**
926926
* The soundboard sounds in the guild
927927
*
928-
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
928+
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
929929
*
930930
* @see {@link https://discord.com/developers/docs/resources/soundboard#soundboard-sound-object}
931931
*/

deno/gateway/v9.ts

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -846,13 +846,13 @@ export interface GatewayGuildCreateDispatchData extends APIGuild {
846846
/**
847847
* When this guild was joined at
848848
*
849-
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
849+
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
850850
*/
851851
joined_at: string;
852852
/**
853853
* `true` if this is considered a large guild
854854
*
855-
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
855+
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
856856
*/
857857
large: boolean;
858858
/**
@@ -862,69 +862,69 @@ export interface GatewayGuildCreateDispatchData extends APIGuild {
862862
/**
863863
* Total number of members in this guild
864864
*
865-
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
865+
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
866866
*/
867867
member_count: number;
868868
/**
869869
* States of members currently in voice channels; lacks the `guild_id` key
870870
*
871-
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
871+
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
872872
*
873873
* @see {@link https://discord.com/developers/docs/resources/voice#voice-state-object}
874874
*/
875875
voice_states: Omit<APIVoiceState, 'guild_id'>[];
876876
/**
877877
* Users in the guild
878878
*
879-
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
879+
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
880880
*
881881
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
882882
*/
883883
members: APIGuildMember[];
884884
/**
885885
* Channels in the guild
886886
*
887-
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
887+
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
888888
*
889889
* @see {@link https://discord.com/developers/docs/resources/channel#channel-object}
890890
*/
891891
channels: (APIChannel & { type: Exclude<GuildChannelType, ThreadChannelType> })[];
892892
/**
893893
* Threads in the guild
894894
*
895-
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
895+
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
896896
*
897897
* @see {@link https://discord.com/developers/docs/resources/channel#channel-object}
898898
*/
899899
threads: (APIChannel & { type: ThreadChannelType })[];
900900
/**
901901
* Presences of the members in the guild, will only include non-offline members if the size is greater than `large_threshold`
902902
*
903-
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
903+
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
904904
*
905905
* @see {@link https://discord.com/developers/docs/topics/gateway-events#presence-update}
906906
*/
907907
presences: GatewayPresenceUpdate[];
908908
/**
909909
* The stage instances in the guild
910910
*
911-
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
911+
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
912912
*
913913
* @see {@link https://discord.com/developers/docs/resources/stage-instance#stage-instance-object-stage-instance-structure}
914914
*/
915915
stage_instances: APIStageInstance[];
916916
/**
917917
* The scheduled events in the guild
918918
*
919-
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
919+
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
920920
*
921921
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object}
922922
*/
923923
guild_scheduled_events: APIGuildScheduledEvent[];
924924
/**
925925
* The soundboard sounds in the guild
926926
*
927-
* **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event**
927+
* **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event**
928928
*
929929
* @see {@link https://discord.com/developers/docs/resources/soundboard#soundboard-sound-object}
930930
*/

deno/payloads/v10/application.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -209,13 +209,13 @@ export enum ApplicationFlags {
209209
/**
210210
* Intent required for bots in 100 or more servers to receive member-related events like `guild_member_add`.
211211
*
212-
* @see List of member-related events [under `GUILD_MEMBERS`](https://discord.com/developers/docs/topics/gateway#list-of-intents)
212+
* @see List of member-related events {@link https://discord.com/developers/docs/topics/gateway#list-of-intents | under `GUILD_MEMBERS`}
213213
*/
214214
GatewayGuildMembers = 1 << 14,
215215
/**
216216
* Intent required for bots in under 100 servers to receive member-related events like `guild_member_add`, found in Bot Settings.
217217
*
218-
* @see List of member-related events [under `GUILD_MEMBERS`](https://discord.com/developers/docs/topics/gateway#list-of-intents)
218+
* @see List of member-related events {@link https://discord.com/developers/docs/topics/gateway#list-of-intents | under `GUILD_MEMBERS`}
219219
*/
220220
GatewayGuildMembersLimited = 1 << 15,
221221
/**
@@ -227,11 +227,11 @@ export enum ApplicationFlags {
227227
*/
228228
Embedded = 1 << 17,
229229
/**
230-
* Intent required for bots in 100 or more servers to receive [message content](https://support-dev.discord.com/hc/en-us/articles/4404772028055)
230+
* Intent required for bots in 100 or more servers to receive {@link https://support-dev.discord.com/hc/en-us/articles/4404772028055 | message content}
231231
*/
232232
GatewayMessageContent = 1 << 18,
233233
/**
234-
* Intent required for bots in under 100 servers to receive [message content](https://support-dev.discord.com/hc/en-us/articles/4404772028055),
234+
* Intent required for bots in under 100 servers to receive {@link https://support-dev.discord.com/hc/en-us/articles/4404772028055 | message content},
235235
* found in Bot Settings
236236
*/
237237
GatewayMessageContentLimited = 1 << 19,
@@ -240,7 +240,7 @@ export enum ApplicationFlags {
240240
*/
241241
EmbeddedFirstParty = 1 << 20,
242242
/**
243-
* Indicates if an app has registered global [application commands](https://discord.com/developers/docs/interactions/application-commands)
243+
* Indicates if an app has registered global {@link https://discord.com/developers/docs/interactions/application-commands | application commands}
244244
*/
245245
ApplicationCommandBadge = 1 << 23,
246246
}

deno/payloads/v10/guild.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -741,6 +741,7 @@ export enum GuildMemberFlags {
741741
AutomodQuarantinedUsernameOrGuildNickname = 1 << 7,
742742
/**
743743
* @deprecated
744+
* {@link https://github.com/discord/discord-api-docs/pull/7113 | discord-api-docs#7113}
744745
*/
745746
AutomodQuarantinedBio = 1 << 8,
746747
/**

deno/payloads/v10/invite.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ export interface APIInvite {
8484
* The stage instance data if there is a public stage instance in the stage channel this invite is for
8585
*
8686
* @deprecated
87+
* {@link https://github.com/discord/discord-api-docs/pull/4479 | discord-api-docs#4479}
8788
*/
8889
stage_instance?: APIInviteStageInstance;
8990
/**

deno/payloads/v10/oauth2.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ export enum OAuth2Scopes {
88
*/
99
Bot = 'bot',
1010
/**
11-
* Allows [/users/\@me/connections](https://discord.com/developers/docs/resources/user#get-user-connections)
11+
* Allows {@link https://discord.com/developers/docs/resources/user#get-user-connections | `/users/@me/connections`}
1212
* to return linked third-party accounts
1313
*
1414
* @see {@link https://discord.com/developers/docs/resources/user#get-user-connections}
@@ -19,26 +19,26 @@ export enum OAuth2Scopes {
1919
*/
2020
DMChannelsRead = 'dm_channels.read',
2121
/**
22-
* Enables [/users/\@me](https://discord.com/developers/docs/resources/user#get-current-user) to return an `email`
22+
* Enables {@link https://discord.com/developers/docs/resources/user#get-current-user | `/users/@me`} to return an `email`
2323
*
2424
* @see {@link https://discord.com/developers/docs/resources/user#get-current-user}
2525
*/
2626
Email = 'email',
2727
/**
28-
* Allows [/users/\@me](https://discord.com/developers/docs/resources/user#get-current-user) without `email`
28+
* Allows {@link https://discord.com/developers/docs/resources/user#get-current-user | `/users/@me`} without `email`
2929
*
3030
* @see {@link https://discord.com/developers/docs/resources/user#get-current-user}
3131
*/
3232
Identify = 'identify',
3333
/**
34-
* Allows [/users/\@me/guilds](https://discord.com/developers/docs/resources/user#get-current-user-guilds)
34+
* Allows {@link https://discord.com/developers/docs/resources/user#get-current-user-guilds | `/users/@me/guilds`}
3535
* to return basic information about all of a user's guilds
3636
*
3737
* @see {@link https://discord.com/developers/docs/resources/user#get-current-user-guilds}
3838
*/
3939
Guilds = 'guilds',
4040
/**
41-
* Allows [/guilds/\{guild.id\}/members/\{user.id\}](https://discord.com/developers/docs/resources/guild#add-guild-member)
41+
* Allows {@link https://discord.com/developers/docs/resources/guild#add-guild-member | `/guilds/[guild.id]/members/[user.id]`}
4242
* to be used for joining users to a guild
4343
*
4444
* @see {@link https://discord.com/developers/docs/resources/guild#add-guild-member}

deno/payloads/v10/stageInstance.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ export interface APIStageInstance {
3131
* Whether or not stage discovery is disabled
3232
*
3333
* @deprecated
34+
* {@link https://github.com/discord/discord-api-docs/pull/4296 | discord-api-docs#4296}
3435
*/
3536
discoverable_disabled: boolean;
3637
/**
@@ -47,6 +48,7 @@ export enum StageInstancePrivacyLevel {
4748
* The stage instance is visible publicly, such as on stage discovery
4849
*
4950
* @deprecated
51+
* {@link https://github.com/discord/discord-api-docs/pull/4296 | discord-api-docs#4296}
5052
*/
5153
Public = 1,
5254
/**
@@ -57,6 +59,9 @@ export enum StageInstancePrivacyLevel {
5759

5860
/**
5961
* https://discord.com/developers/docs/resources/invite#invite-stage-instance-object-invite-stage-instance-structure
62+
*
63+
* @deprecated
64+
* {@link https://github.com/discord/discord-api-docs/pull/4479 | discord-api-docs#4479}
6065
*/
6166
export interface APIInviteStageInstance {
6267
/**

deno/payloads/v10/user.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ export enum UserFlags {
143143
*/
144144
PremiumEarlySupporter = 1 << 9,
145145
/**
146-
* User is a [team](https://discord.com/developers/docs/topics/teams)
146+
* User is a {@link https://discord.com/developers/docs/topics/teams | team}
147147
*/
148148
TeamPseudoUser = 1 << 10,
149149
/**
@@ -167,7 +167,7 @@ export enum UserFlags {
167167
*/
168168
CertifiedModerator = 1 << 18,
169169
/**
170-
* 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
170+
* 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
171171
*/
172172
BotHTTPInteractions = 1 << 19,
173173
/**
@@ -181,11 +181,11 @@ export enum UserFlags {
181181
*/
182182
DisablePremium = 1 << 21,
183183
/**
184-
* User is an [Active Developer](https://support-dev.discord.com/hc/articles/10113997751447)
184+
* User is an {@link https://support-dev.discord.com/hc/articles/10113997751447 | Active Developer}
185185
*/
186186
ActiveDeveloper = 1 << 22,
187187
/**
188-
* User's account has been [quarantined](https://support.discord.com/hc/articles/6461420677527) based on recent activity
188+
* User's account has been {@link https://support.discord.com/hc/articles/6461420677527 | quarantined} based on recent activity
189189
*
190190
* @unstable This user flag is currently not documented by Discord but has a known value which we will try to keep up to date.
191191
* @privateRemarks

deno/payloads/v9/application.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -209,13 +209,13 @@ export enum ApplicationFlags {
209209
/**
210210
* Intent required for bots in 100 or more servers to receive member-related events like `guild_member_add`.
211211
*
212-
* @see List of member-related events [under `GUILD_MEMBERS`](https://discord.com/developers/docs/topics/gateway#list-of-intents)
212+
* @see List of member-related events {@link https://discord.com/developers/docs/topics/gateway#list-of-intents | under `GUILD_MEMBERS`}
213213
*/
214214
GatewayGuildMembers = 1 << 14,
215215
/**
216216
* Intent required for bots in under 100 servers to receive member-related events like `guild_member_add`, found in Bot Settings.
217217
*
218-
* @see List of member-related events [under `GUILD_MEMBERS`](https://discord.com/developers/docs/topics/gateway#list-of-intents)
218+
* @see List of member-related events {@link https://discord.com/developers/docs/topics/gateway#list-of-intents | under `GUILD_MEMBERS`}
219219
*/
220220
GatewayGuildMembersLimited = 1 << 15,
221221
/**
@@ -227,11 +227,11 @@ export enum ApplicationFlags {
227227
*/
228228
Embedded = 1 << 17,
229229
/**
230-
* Intent required for bots in 100 or more servers to receive [message content](https://support-dev.discord.com/hc/en-us/articles/4404772028055)
230+
* Intent required for bots in 100 or more servers to receive {@link https://support-dev.discord.com/hc/en-us/articles/4404772028055 | message content}
231231
*/
232232
GatewayMessageContent = 1 << 18,
233233
/**
234-
* Intent required for bots in under 100 servers to receive [message content](https://support-dev.discord.com/hc/en-us/articles/4404772028055),
234+
* Intent required for bots in under 100 servers to receive {@link https://support-dev.discord.com/hc/en-us/articles/4404772028055 | message content},
235235
* found in Bot Settings
236236
*/
237237
GatewayMessageContentLimited = 1 << 19,
@@ -240,7 +240,7 @@ export enum ApplicationFlags {
240240
*/
241241
EmbeddedFirstParty = 1 << 20,
242242
/**
243-
* Indicates if an app has registered global [application commands](https://discord.com/developers/docs/interactions/application-commands)
243+
* Indicates if an app has registered global {@link https://discord.com/developers/docs/interactions/application-commands | application commands}
244244
*/
245245
ApplicationCommandBadge = 1 << 23,
246246
}

deno/payloads/v9/guild.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -733,6 +733,7 @@ export enum GuildMemberFlags {
733733
AutomodQuarantinedUsernameOrGuildNickname = 1 << 7,
734734
/**
735735
* @deprecated
736+
* {@link https://github.com/discord/discord-api-docs/pull/7113 | discord-api-docs#7113}
736737
*/
737738
AutomodQuarantinedBio = 1 << 8,
738739
/**

0 commit comments

Comments
 (0)