leaderboard()

This function is used to generate an array of the top users in a guild.

Parameters

Parameter	Type	Required	Default	Description
client	Client	✅		The client object.
guildID	string	✅		The Guild ID
limit	number	❌	♾️	The limit of the leaderboard.

Returns

• Promise<object[]>

Example:

[
  {
   guildID: "123456789",
   userID: "123456789012345",
   level: 69,
   xp: 476100,
   position: 1, // considered as "rank" 
   username: "Abadima",
   tag: "Abadima#6356",
   shortxp: 476k,
  },
  // etc
]

Throws

• new Error() - if invalid parameters are provided, or guild is not found.

[JS] Example

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

const guildid = "867999056172052551"; // Use undefined for global leaderboard
const limit = 10;

leaderboard(client, guildid, limit)
	.then(console.log) // Returns the leaderboard array
	.catch((err) => console.log(err)); // Returns the error