roleSetup

This class provides methods to interact with the database. Used for performing operations like creating, updating, deleting, and querying documents.

Methods

roleSetup.add()

Adds a role to the role setup.

Parameters

Parameter	Type	Required	Description
guildId	string	✅	The guild ID of the role setup.
options	RoleSetupObject	✅	The options for the role setup.

Returns

• Promise<boolean> - If the role was added successfully.

Throws

• XpFatal - If an invalid type or value is provided.

---

roleSetup.getRoles()

Gets the roles of user's current level, with options to include more roles.

Parameters

Parameter	Type	Required	Description
userId	string	✅	The ID of the user.
guildId	string	✅	The guild ID.
options	GetRolesOptions	❌	The options for the role setup.

Returns

• Promise<string[]> - The roles of the user (or empty array if none).

Throws

• XpFatal - If invalid parameters are provided.

---

roleSetup.find()

Finds a role in the role setup.

Parameters

Parameter	Type	Required	Description
guildId	string	✅	The guild ID of the role setup.
levelNumber	number	✅	The level number of the role setup.

Returns

• Promise<RoleSetupObject> - The role setup object.

Throws

• XpFatal - If an invalid type or value is provided.

---

roleSetup.list()

Lists all level roles in a guild.

Parameters

Parameter	Type	Required	Description
guildId	string	✅	The guild ID of the role setup.

Returns

• Promise<RoleSetupObject[]> - The role setup objects.

Throws

• XpFatal - If there are no level roles in the guild.

---

roleSetup.remove()

Removes a role from the role setup.

Parameters

Parameter	Type	Required	Description
guildId	string	✅	The guild ID of the role setup.
levelNumber	number	✅	The level number of the role setup.

Returns

• Promise<boolean> - If the role was removed successfully.

Throws

• XpFatal - If an invalid type or value is provided.