CDNRoutesDeclarations

Index

Methods

• achievementIcon
• applicationAsset
• applicationCover
• applicationIcon
• avatarDecoration
• defaultUserAvatar
• emoji
• guildBanner
• guildDiscoverySplash
• guildIcon
• guildMemberAvatar
• guildMemberBanner
• guildScheduledEventCover
• guildSplash
• guildTagBadge
• roleIcon
• soundboardSound
• sticker
• stickerPackBanner
• storePageAsset
• teamIcon
• userAvatar
• userAvatarDecoration
• userBanner

Methods

achievementIcon

• achievementIcon(applicationId: string, achievementId: string, achievementIconHash: string, format: Format): `/app-assets/${string}/achievements/${string}/icons/${string}.${Format}`

• Route for:

  • GET /app-assets/{application.id}/achievements/{achievement.id}/icons/{achievement.icon}.{png|jpeg|webp}

  This route supports the extensions: PNG, JPEG, WebP

  ---

  Parameters

  • applicationId: string

  • achievementId: string

  • achievementIconHash: string

  • format: Format

  Returns `/app-assets/${string}/achievements/${string}/icons/${string}.${Format}`

applicationAsset

• applicationAsset(applicationId: string, applicationAssetId: string, format: Format): `/app-assets/${string}/${string}.${Format}`

• Route for:

  • GET /app-assets/{application.id}/{application.asset_id}.{png|jpeg|webp}

  This route supports the extensions: PNG, JPEG, WebP

  ---

  Parameters

  • applicationId: string

  • applicationAssetId: string

  • format: Format

  Returns `/app-assets/${string}/${string}.${Format}`

applicationCover

• applicationCover(applicationId: string, applicationCoverImage: string, format: Format): `/app-icons/${string}/${string}.${Format}`

• Route for:

  • GET /app-icons/{application.id}/{application.cover_image}.{png|jpeg|webp}

  This route supports the extensions: PNG, JPEG, WebP

  ---

  Parameters

  • applicationId: string

  • applicationCoverImage: string

  • format: Format

  Returns `/app-icons/${string}/${string}.${Format}`

applicationIcon

• applicationIcon(applicationId: string, applicationIcon: string, format: Format): `/app-icons/${string}/${string}.${Format}`

• Route for:

  • GET /app-icons/{application.id}/{application.icon}.{png|jpeg|webp}

  This route supports the extensions: PNG, JPEG, WebP

  ---

  Parameters

  • applicationId: string

  • applicationIcon: string

  • format: Format

  Returns `/app-icons/${string}/${string}.${Format}`

avatarDecoration

• avatarDecoration(avatarDecorationDataAsset: string): `/avatar-decoration-presets/${string}.png`

• Route for:

  • GET /avatar-decoration-presets/{avatar_decoration_data_asset}.png

  This route supports the extension: PNG

  ---

  Parameters

  • avatarDecorationDataAsset: string

  Returns `/avatar-decoration-presets/${string}.png`

defaultUserAvatar

• defaultUserAvatar(index: Index): `/embed/avatars/${Index}.png`

• Route for:

  • GET /embed/avatars/{index}.png

  The value for index parameter depends on whether the user is to the new username system. For users on the new username system, index will be (user.id >> 22) % 6. For users on the legacy username system, index will be user.discriminator % 5.

  This route supports the extension: PNG

  ---

  Parameters

  • index: Index

  Returns `/embed/avatars/${Index}.png`

emoji

• emoji(emojiId: string, format: Format): `/emojis/${string}.${Format}`

• Route for:

  • GET /emojis/{emoji.id}.{png|jpeg|webp|gif}

  As this route supports GIFs, the hash will begin with a_ if it is available in GIF format

  This route supports the extensions: PNG, JPEG, WebP, GIF

  ---

  Parameters

  • emojiId: string

  • format: Format

  Returns `/emojis/${string}.${Format}`

guildBanner

• guildBanner(guildId: string, guildBanner: string, format: Format): `/banners/${string}/${string}.${Format}`

• Route for:

  • GET /banners/{guild.id}/{guild.banner}.{png|jpeg|webp|gif}

  As this route supports GIFs, the hash will begin with a_ if it is available in GIF format

  This route supports the extensions: PNG, JPEG, WebP, GIF

  ---

  Parameters

  • guildId: string

  • guildBanner: string

  • format: Format

  Returns `/banners/${string}/${string}.${Format}`

guildDiscoverySplash

• guildDiscoverySplash(guildId: string, guildDiscoverySplash: string, format: Format): `/discovery-splashes/${string}/${string}.${Format}`

• Route for:

  • GET /discovery-splashes/{guild.id}/{guild.discovery_splash}.{png|jpeg|webp}

  This route supports the extensions: PNG, JPEG, WebP

  ---

  Parameters

  • guildId: string

  • guildDiscoverySplash: string

  • format: Format

  Returns `/discovery-splashes/${string}/${string}.${Format}`

guildIcon

• guildIcon(guildId: string, guildIcon: string, format: Format): `/icons/${string}/${string}.${Format}`

• Route for:

  • GET /icons/{guild.id}/{guild.icon}.{png|jpeg|webp|gif}

  As this route supports GIFs, the hash will begin with a_ if it is available in GIF format

  This route supports the extensions: PNG, JPEG, WebP, GIF

  ---

  Parameters

  • guildId: string

  • guildIcon: string

  • format: Format

  Returns `/icons/${string}/${string}.${Format}`

guildMemberAvatar

• guildMemberAvatar(guildId: string, userId: string, memberAvatar: string, format: Format): `/guilds/${string}/users/${string}/avatars/${string}.${Format}`

• Route for:

  • GET /guilds/{guild.id}/users/{user.id}/avatars/{guild_member.avatar}.{png|jpeg|webp|gif}

  As this route supports GIFs, the hash will begin with a_ if it is available in GIF format

  This route supports the extensions: PNG, JPEG, WebP, GIF

  ---

  Parameters

  • guildId: string

  • userId: string

  • memberAvatar: string

  • format: Format

  Returns `/guilds/${string}/users/${string}/avatars/${string}.${Format}`

guildMemberBanner

• guildMemberBanner(guildId: string, userId: string, guildMemberBanner: string, format: Format): `/guilds/${string}/users/${string}/banners/${string}.${Format}`

• Route for:

  • GET /guilds/${guild.id}/users/${user.id}/banners/${guild_member.banner}.{png|jpeg|webp|gif}

  This route supports the extensions: PNG, JPEG, WebP, GIF

  ---

  Parameters

  • guildId: string

  • userId: string

  • guildMemberBanner: string

  • format: Format

  Returns `/guilds/${string}/users/${string}/banners/${string}.${Format}`

guildScheduledEventCover

• guildScheduledEventCover(guildScheduledEventId: string, guildScheduledEventCoverImage: string, format: Format): `/guild-events/${string}/${string}.${Format}`

• Route for:

  • GET /guild-events/{guild_scheduled_event.id}/{guild_scheduled_event.image}.{png|jpeg|webp}

  This route supports the extensions: PNG, JPEG, WebP

  ---

  Parameters

  • guildScheduledEventId: string

  • guildScheduledEventCoverImage: string

  • format: Format

  Returns `/guild-events/${string}/${string}.${Format}`

guildSplash

• guildSplash(guildId: string, guildSplash: string, format: Format): `/splashes/${string}/${string}.${Format}`

• Route for:

  • GET /splashes/{guild.id}/{guild.splash}.{png|jpeg|webp}

  This route supports the extensions: PNG, JPEG, WebP

  ---

  Parameters

  • guildId: string

  • guildSplash: string

  • format: Format

  Returns `/splashes/${string}/${string}.${Format}`

guildTagBadge

• guildTagBadge(guildId: string, guildTagBadge: string, format: Format): `/guild-tag-badges/${string}/${string}.${Format}`

• Route for:

  • GET /guild-tag-badges/{guild.id}/{badge}.{png|jpeg|webp}

  This route supports the extensions: PNG, JPEG, WebP

  ---

  Parameters

  • guildId: string

  • guildTagBadge: string

  • format: Format

  Returns `/guild-tag-badges/${string}/${string}.${Format}`

roleIcon

• roleIcon(roleId: string, roleIcon: string, format: Format): `/role-icons/${string}/${string}.${Format}`

• Route for:

  • GET /role-icons/{role.id}/{role.icon}.{png|jpeg|webp}

  This route supports the extensions: PNG, JPEG, WebP

  ---

  Parameters

  • roleId: string

  • roleIcon: string

  • format: Format

  Returns `/role-icons/${string}/${string}.${Format}`

soundboardSound

• soundboardSound(soundId: string): `/soundboard-sounds/${string}`

• Route for:

  • GET /soundboard-sounds/${sound.id}

  ---

  Parameters

  • soundId: string

  Returns `/soundboard-sounds/${string}`

sticker

• sticker(stickerId: string, format: Format): `/stickers/${string}.${Format}`

• Route for:

  • GET /stickers/{sticker.id}.{png|json}

  This route supports the extensions: PNG, Lottie, GIF

  ---

  Parameters

  • stickerId: string

  • format: Format

  Returns `/stickers/${string}.${Format}`

stickerPackBanner

• stickerPackBanner(stickerPackBannerAssetId: string, format: Format): `/app-assets/710982414301790216/store/${string}.${Format}`

• Route for:

  • GET /app-assets/710982414301790216/store/{sticker_pack.banner.asset_id}.{png|jpeg|webp}

  This route supports the extensions: PNG, JPEG, WebP

  ---

  Parameters

  • stickerPackBannerAssetId: string

  • format: Format

  Returns `/app-assets/710982414301790216/store/${string}.${Format}`

storePageAsset

• storePageAsset(applicationId: string, assetId: string, format?: Format): `/app-assets/${string}/store/${string}.${Format}`

• Route for:

  • GET /app-assets/${application.id}/store/${asset.id}.{png|jpeg|webp}}

  This route supports the extensions: PNG, JPEG, WebP

  ---

  Parameters

  • applicationId: string

  • assetId: string

  • optionalformat: Format

  Returns `/app-assets/${string}/store/${string}.${Format}`

teamIcon

• teamIcon(teamId: string, teamIcon: string, format: Format): `/team-icons/${string}/${string}.${Format}`

• Route for:

  • GET /team-icons/{team.id}/{team.icon}.{png|jpeg|webp}

  This route supports the extensions: PNG, JPEG, WebP

  ---

  Parameters

  • teamId: string

  • teamIcon: string

  • format: Format

  Returns `/team-icons/${string}/${string}.${Format}`

userAvatar

• userAvatar(userId: string, userAvatar: string, format: Format): `/avatars/${string}/${string}.${Format}`

• Route for:

  • GET /avatars/{user.id}/{user.avatar}.{png|jpeg|webp|gif}

  As this route supports GIFs, the hash will begin with a_ if it is available in GIF format

  This route supports the extensions: PNG, JPEG, WebP, GIF

  ---

  Parameters

  • userId: string

  • userAvatar: string

  • format: Format

  Returns `/avatars/${string}/${string}.${Format}`

userAvatarDecoration

• userAvatarDecoration(userId: string, userAvatarDecoration: string): `/avatar-decorations/${string}/${string}.png`

• Route for:

  • GET /avatar-decorations/{user.id}/{user.avatar_decoration}.png

  This route supports the extension: PNG

  @deprecated

  Use CDNRoutesDeclarations.avatarDecoration instead.

  ---

  Parameters

  • userId: string

  • userAvatarDecoration: string

  Returns `/avatar-decorations/${string}/${string}.png`

userBanner

• userBanner(userId: string, userBanner: string, format: Format): `/banners/${string}/${string}.${Format}`

• Route for:

  • GET /banners/{user.id}/{user.banner}.{png|jpeg|webp|gif}

  As this route supports GIFs, the hash will begin with a_ if it is available in GIF format

  This route supports the extensions: PNG, JPEG, WebP, GIF

  ---

  Parameters

  • userId: string

  • userBanner: string

  • format: Format

  Returns `/banners/${string}/${string}.${Format}`