roleSetup
Cette classe fournit des méthodes pour interagir avec la base de données. Elle est utilisée pour effectuer des opérations telles que la création, la mise à jour, la suppression et la consultation de documents.
info
La v2 a ajouté les Tableaux de rôles.
En conséquence, il est recommandé de gérer à la fois les tableaux et les chaînes pour les méthodes find et fetch, surtout si vous avez déjà utilisé la v2.
Méthodes
roleSetup.add()
Ajoute un rôle à la configuration des rôles.
Paramètres
| Paramètre | Type | Requis | Description |
|---|---|---|---|
| client | Client | ✅ | Le client Discord. |
| guildId | string | ✅ | L'ID de la guilde de la configuration des rôles. |
| options | LevelAddOptions | ✅ | Les options pour l'ajout du rôle. |
Retour
- Promise<
boolean> -truesi le rôle a été ajouté avec succès.
Erreurs
new Error()- Si un type ou une valeur invalide est fourni.
roleSetup.find()
Recherche un rôle dans la configuration des rôles.
Paramètres
| Paramètre | Type | Requis | Description |
|---|---|---|---|
| guildId | string | ✅ | L'ID de la guilde de la configuration des rôles. |
| level | number | ✅ | Le numéro du niveau recherché. |
Retour
- Promise<
{ lvl: number, role: string || string[] }> - L'objet de configuration du rôle trouvé.
Erreurs
new Error()- Si un type ou une valeur invalide est fourni.
roleSetup.fetch()
Liste tous les rôles de niveau d'une guilde.
Paramètres
| Paramètre | Type | Requis | Description |
|---|---|---|---|
| client | Client | ✅ | Le client Discord. |
| guildId | string | ✅ | L'ID de la guilde. |
Retour
- Promise<
Array<{ lvl: number, role: string || string[] }>> - Tableau des objets de configuration des rôles.
Erreurs
XpFatal- S'il n'y a aucun rôle de niveau dans la guilde.
roleSetup.remove()
Supprime un rôle de la configuration des rôles.
Paramètres
| Paramètre | Type | Requis | Description |
|---|---|---|---|
| client | Client | ✅ | Le client Discord. |
| guildId | string | ✅ | L'ID de la guilde. |
| options | LevelRemoveOptions | ✅ | Les options pour la suppression du rôle. |
Retour
- Promise<
boolean> -truesi le rôle a été supprimé avec succès.
Erreurs
new Error()- Si un type ou une valeur invalide est fourni.
LevelAddOptions
| Options | Type | Requis | Description |
|---|---|---|---|
| level | number | ✅ | Niveau auquel ajouter le rôle. |
| role | Role ID | ✅ | ID du rôle à ajouter. |
LevelRemoveOptions
| Options | Type | Requis | Description |
|---|---|---|---|
| level | number | ✅ | Niveau depuis lequel retirer les rôles. |