discord.js | CDNRoutesDeclarations

Search...

CDNRoutesDeclarations

export interface CDNRoutesDeclarations

export interface CDNRoutesDeclarations

No summary provided.

achievementIcon(applicationId, achievementId, achievementIconHash, 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

Name	Constraints	Optional	Default	Description
Format	AchievementIconFormat	No		None

Name	Type	Optional	Description
applicationId	Snowflake	No	None
achievementId	Snowflake	No	None
achievementIconHash	string	No	None
format	Format	No	None

applicationAsset(applicationId, applicationAssetId, 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

Name	Constraints	Optional	Default	Description
Format	ApplicationAssetFormat	No		None

Name	Type	Optional	Description
applicationId	Snowflake	No	None
applicationAssetId	string	No	None
format	Format	No	None

applicationCover(applicationId, applicationCoverImage, 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

Name	Constraints	Optional	Default	Description
Format	ApplicationCoverFormat	No		None

Name	Type	Optional	Description
applicationId	Snowflake	No	None
applicationCoverImage	string	No	None
format	Format	No	None

applicationIcon(applicationId, applicationIcon, 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

Name	Constraints	Optional	Default	Description
Format	ApplicationIconFormat	No		None

Name	Type	Optional	Description
applicationId	Snowflake	No	None
applicationIcon	string	No	None
format	Format	No	None

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

Route for: - GET /avatar-decoration-presets/{avatar_decoration_data_asset}.pngThis route supports the extension: PNG

Name	Type	Optional	Description
avatarDecorationDataAsset	string	No	None

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

Route for: - GET /embed/avatars/{index}.pngThe value for index parameter depends on whether the user is migrated 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

Name	Constraints	Optional	Default	Description
Index	DefaultUserAvatarAssets	No		None

Name	Type	Optional	Description
index	Index	No	None

emoji(emojiId, 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 formatThis route supports the extensions: PNG, JPEG, WebP, GIF

Name	Constraints	Optional	Default	Description
Format	EmojiFormat	No		None

Name	Type	Optional	Description
emojiId	Snowflake	No	None
format	Format	No	None

guildBanner(guildId, guildBanner, 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 formatThis route supports the extensions: PNG, JPEG, WebP, GIF

Name	Constraints	Optional	Default	Description
Format	GuildBannerFormat	No		None

Name	Type	Optional	Description
guildId	Snowflake	No	None
guildBanner	string	No	None
format	Format	No	None

guildDiscoverySplash(guildId, guildDiscoverySplash, 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

Name	Constraints	Optional	Default	Description
Format	GuildDiscoverySplashFormat	No		None

Name	Type	Optional	Description
guildId	Snowflake	No	None
guildDiscoverySplash	string	No	None
format	Format	No	None

guildIcon(guildId, guildIcon, 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 formatThis route supports the extensions: PNG, JPEG, WebP, GIF

Name	Constraints	Optional	Default	Description
Format	GuildIconFormat	No		None

Name	Type	Optional	Description
guildId	Snowflake	No	None
guildIcon	string	No	None
format	Format	No	None

guildMemberAvatar(guildId, userId, memberAvatar, 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 formatThis route supports the extensions: PNG, JPEG, WebP, GIF

Name	Constraints	Optional	Default	Description
Format	GuildMemberAvatarFormat	No		None

Name	Type	Optional	Description
guildId	Snowflake	No	None
userId	Snowflake	No	None
memberAvatar	string	No	None
format	Format	No	None

guildMemberBanner(guildId, userId, guildMemberBanner, 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

Name	Constraints	Optional	Default	Description
Format	GuildMemberBannerFormat	No		None

Name	Type	Optional	Description
guildId	Snowflake	No	None
userId	Snowflake	No	None
guildMemberBanner	string	No	None
format	Format	No	None

guildScheduledEventCover(guildScheduledEventId, guildScheduledEventCoverImage, 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

Name	Constraints	Optional	Default	Description
Format	GuildScheduledEventCoverFormat	No		None

Name	Type	Optional	Description
guildScheduledEventId	Snowflake	No	None
guildScheduledEventCoverImage	string	No	None
format	Format	No	None

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

Route for: - GET /splashes/{guild.id}/{guild.splash}.{png|jpeg|webp}This route supports the extensions: PNG, JPEG, WebP

Name	Constraints	Optional	Default	Description
Format	GuildSplashFormat	No		None

Name	Type	Optional	Description
guildId	Snowflake	No	None
guildSplash	string	No	None
format	Format	No	None

guildTagBadge(guildId, guildTagBadge, 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

Name	Constraints	Optional	Default	Description
Format	GuildTagBadgeFormat	No		None

Name	Type	Optional	Description
guildId	Snowflake	No	None
guildTagBadge	string	No	None
format	Format	No	None

roleIcon(roleId, roleIcon, 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

Name	Constraints	Optional	Default	Description
Format	RoleIconFormat	No		None

Name	Type	Optional	Description
roleId	Snowflake	No	None
roleIcon	string	No	None
format	Format	No	None

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

Route for: - GET /soundboard-sounds/${sound.id}

Name	Type	Optional	Description
soundId	Snowflake	No	None

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

Route for: - GET /stickers/{sticker.id}.{png|json}This route supports the extensions: PNG, Lottie, GIF

Name	Constraints	Optional	Default	Description
Format	StickerFormat	No		None

Name	Type	Optional	Description
stickerId	Snowflake	No	None
format	Format	No	None

stickerPackBanner(stickerPackBannerAssetId, 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

Name	Constraints	Optional	Default	Description
Format	StickerPackBannerFormat	No		None

Name	Type	Optional	Description
stickerPackBannerAssetId	Snowflake	No	None
format	Format	No	None

storePageAsset(applicationId, assetId, 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

Name	Constraints	Optional	Default	Description
Format	StorePageAssetFormat	Yes	ImageFormat.PNG	None

Name	Type	Optional	Description
applicationId	Snowflake	No	None
assetId	string	No	None
format	Format	Yes	None

teamIcon(teamId, teamIcon, 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

Name	Constraints	Optional	Default	Description
Format	TeamIconFormat	No		None

Name	Type	Optional	Description
teamId	Snowflake	No	None
teamIcon	string	No	None
format	Format	No	None

userAvatar(userId, userAvatar, 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 formatThis route supports the extensions: PNG, JPEG, WebP, GIF

Name	Constraints	Optional	Default	Description
Format	UserAvatarFormat	No		None

Name	Type	Optional	Description
userId	Snowflake	No	None
userAvatar	string	No	None
format	Format	No	None

Deprecated

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

Use avatarDecoration instead.

Deprecated

Route for: - GET /avatar-decorations/{user.id}/{user.avatar_decoration}.pngThis route supports the extension: PNG

Name	Type	Optional	Description
userId	Snowflake	No	None
userAvatarDecoration	string	No	None

userBanner(userId, userBanner, 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 formatThis route supports the extensions: PNG, JPEG, WebP, GIF

Name	Constraints	Optional	Default	Description
Format	UserBannerFormat	No		None

Name	Type	Optional	Description
userId	Snowflake	No	None
userBanner	string	No	None
format	Format	No	None