Aller au contenu principal

leaderboardCard()

Cette fonction est utilisée pour générer une image du classement du serveur.

Paramètres

ParamètreTypeRequisPar défautDescription
dataArrayUserLe tableau des utilisateurs.
optionsLeaderboardCardOptions{}Les options pour la carte de classement.
guildInfo{name: string, imageURL: URL, memberCount: number}{}Les informations sur la guilde.
localesLeaderboardCardLocales{}Les paramètres régionaux pour la carte de classement.

Retours

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

Lance

  • XpFatal - si des paramètres invalides sont fournis.

Exemple [JS]

const {leaderboard, leaderboardCard} = require('simply-xp');

const guildId = "867999056172052551";

leaderboardCard(await leaderboard(guildId))
.then(console.log) // Retourne l'objet de la carte de classement
.catch((err) => console.log(err)); // Retourne l'erreur