Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-15 11:03:30 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: add note about idempotence to role add/remove routes (#10586)

Browse Source 
* chore(docs): Add note about idempotence to role add/remove routes

* chore: remove trailing spaces
This commit is contained in:
Souji
2024-11-05 10:29:29 +01:00
committed by GitHub
parent 1fd662629d
commit f02bdc3be3
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
packages/discord.js/src/managers/GuildMemberRoleManager.js
View File

@@ -101,6 +101,8 @@ class GuildMemberRoleManager extends DataManager {
/** /**
* Adds a role (or multiple roles) to the member. * Adds a role (or multiple roles) to the member.
*
* <info>Uses the idempotent PUT route for singular roles, otherwise PATCHes the underlying guild member</info>
* @param {RoleResolvable|RoleResolvable[]|Collection<Snowflake, Role>} roleOrRoles The role or roles to add * @param {RoleResolvable|RoleResolvable[]|Collection<Snowflake, Role>} roleOrRoles The role or roles to add
* @param {string} [reason] Reason for adding the role(s) * @param {string} [reason] Reason for adding the role(s)
* @returns {Promise<GuildMember>} * @returns {Promise<GuildMember>}
@@ -138,6 +140,8 @@ class GuildMemberRoleManager extends DataManager {
/** /**
* Removes a role (or multiple roles) from the member. * Removes a role (or multiple roles) from the member.
*
* <info>Uses the idempotent DELETE route for singular roles, otherwise PATCHes the underlying guild member</info>
* @param {RoleResolvable|RoleResolvable[]|Collection<Snowflake, Role>} roleOrRoles The role or roles to remove * @param {RoleResolvable|RoleResolvable[]|Collection<Snowflake, Role>} roleOrRoles The role or roles to remove
* @param {string} [reason] Reason for removing the role(s) * @param {string} [reason] Reason for removing the role(s)
* @returns {Promise<GuildMember>} * @returns {Promise<GuildMember>}