Rank
Last updated
Last updated
⇒
Set the user avatar
⇒
Set the user banner
⇒
Set the user badges and frame
⇒
Set the border of the card
⇒
Set the username of the user
⇒
Set the current experience
⇒
Set the required experience
Set the user rank
Establece el nivel del usuario
Set the progress bar
Set the user presence status
Set the user created timestamp
Build the rank card
Kind: global class
Rank card creator
userId
string
User ID
Example
Set the user avatar
APIError
If the URL or asset is invalid
avatarUrl
string
Avatar URL
AvatarDecorationData
string
Avatar decoration asset
squareAvatar
boolean
Square avatar
Set the user banner
APIError
If the URL or asset is invalid
bannerUrl
string
Banner URL
moreBackgroundBlur
boolean
More background blur
disableBackgroundBlur
boolean
Disable background blur
backgroundBrightness
number
Background brightness
Set the user badges and frame
APIError
If the URL or asset is invalid
flags
number
User flags
bot
boolean
Whether the user is a bot or not
frame
boolean
Badge frame
customBadges
Array.<string>
Custom badges
Set the border of the card
APIError
If the URL or asset is invalid
color
string
| Array.<string>
HEX color of the border, can be gradient if 2 colors are used
allign
string
Gradient alignment if 2 colors are used
Set the username of the user
APIError
If the URL or asset is invalid
name
string
Username of the user
[discriminator]
string
""0""
Discriminator of the user
[color]
string
""#FFFFFF""
Color of the username
[customUsername]
string
null
Custom username
[customTag]
string
null
Custom tag
Set the current experience
APIError
If the URL or asset is invalid
data
number
Current experience data
[color]
string
""#FFFFFF""
Text color
Set the required experience
APIError
If the URL or asset is invalid
data
number
Required experience data
[color]
string
""#FFFFFF""
Text color
Set the user rank
APIError
If the URL or asset is invalid
data
number
Rank data
[text]
string
""RANK""
Display text
[display]
boolean
false
Display system rank or not
Establece el nivel del usuario
APIError
If the URL or asset is invalid
data
number
Level data
[text]
string
""LEVEL""
Display text
Set the progress bar
APIError
If the URL or asset is invalid
color
string
| Array.<string>
Color of the progress bar, can be gradient if 2 colors are used
[fillType]
string
""COLOR""
Type of progress bar
[rounded]
boolean
true
Rounded corners of the progress bar
Set the user presence status
APIError
If the URL or asset is invalid
presenceStatus
string
Presence status
Set the user created timestamp
APIError
If the URL or asset is invalid
timestamp
number
Timestamp of when the user joined Discord
customDate
string
| Date
Custom date format for the timestamp
Promise.<Buffer>
Build the rank card
Kind: global function
Returns: Promise.<Buffer>
- Card image in buffer format
Throws:
APIError
Missing field: data
[font]
string
""Arial""
Font to use in the card
⇒
⇒
⇒
⇒
⇒
⇒ Promise.<Buffer>
Kind: global function Returns: - The current instance of Rank Throws:
Kind: global function Returns: - The current instance of Rank Throws:
Kind: global function Returns: - The current instance of Rank Throws:
Kind: global function Returns: - The current instance of Rank Throws:
Kind: global function Returns: - The current instance of Rank Throws:
Kind: global function Returns: - The current instance of Rank Throws:
Kind: global function Returns: - The current instance of Rank Throws:
Kind: global function Returns: - The current instance of Rank Throws:
Kind: global function Returns: - The current instance of Rank Throws:
Kind: global function Returns: - The current instance of Rank Throws:
Kind: global function Returns: - The current instance of Rank Throws:
Kind: global function Returns: - The current instance of Rank Throws: