compareCard()

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

Parameters

Parameter	Type	Required	Description
guild	{id: string, name: string}	✅	The guild object.
user1	CardUserOptions	✅	The first user's object
user2	CardUserOptions	✅	The second user's object
options	RankCardOptions	❌	The options.
locales	RankCardLocales	❌	The locales.

Returns

• Promise<{ attachment: Buffer; description: string; name: string; }>

Throws

• XpFatal - if invalid parameters are provided.

[JS] Example

const {compareCard} = require('simply-xp');

const guild = {
    id: "867999056172052551",
    name: "Simply Develop"
};

const user1 = {
    avatarURL: "https://avatarfiles.alphacoders.com/280/280594.jpg",
    id: "326815959358898189",
    username: "Abadima",
};

const user2 = {
    avatarURL: "https://rahuletto.thedev.id/assets/logo.webp",
    id: "770551872309166090",
    username: "Rahuletto",
};

compareCard(guild, user1, user2)
    .then(console.log) // Returns the rank card object
    .catch((err) => console.log(err)); // Returns the error