rank()

This function is used to generate an image of a user's rank.

warning

This function is replaced by rankCard() in Version 2

Parameters

| Parameter | Type | Required | Description | | :-------- | :--------------------------------------------------------------------------------------------------------------- | :------- | :------------------ | --- | --- | ---------------- | | message | Message | ✅ | The message object. | | userId | string | ✅ | The ID of the user. | | guildId | string | ✅ | The guild ID. | | ✅ | The user object. | | options | RankCardOptions | ❌ | The options. |

Returns Promise<<MessageAttachment>>

Throws

• new Error() - if invalid parameters are provided, or we are unable to fetch the user's avatar.

[JS] Example

const { rank } = require("simply-xp");

const userId = "326815959358898189";
const guildId = "867999056172052551";

rank(message, userId, guildId)
	.then(console.log) // Returns the rank card object
	.catch((err) => console.log(err)); // Returns the error

---

Rank Options

Option	Type	Required	Description
background	URL	❌	The background image.
color	HEX	❌	The color.