Chapril/xmpp.chapril.org-conversejs
Chapril/xmpp.chapril.org-conversejs
25
0
Fork 0
Code Issues Pull Requests Projects Releases Activity

JSDoc improvements

Browse Source
This commit is contained in:
JC Brand 2021-05-13 11:44:19 +02:00
parent ad53a3c9a1
commit 19b34231d4
2 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/headless/plugins/muc/affiliations/api.js
View File

@ -12,14 +12,13 @@ export default {
/** /**
* Set the given affliation for the given JIDs in the specified MUCs * Set the given affliation for the given JIDs in the specified MUCs
* *
* @param { ('outcast'|'member'|'admin'|'owner') } affiliation - The affiliation to be set
* @param { String|Array<String> } muc_jids - The JIDs of the MUCs in * @param { String|Array<String> } muc_jids - The JIDs of the MUCs in
* which the affiliation should be set. * which the affiliation should be set.
* @param { Object[] } users - An array of objects representing users * @param { Object[] } users - An array of objects representing users
* for whom the affiliation is to be set. * for whom the affiliation is to be set.
* @param { string } users[].jid - The JID of the user whose affiliation will change * @param { String } users[].jid - The JID of the user whose affiliation will change
* @param { Array } users[].affiliation - The new affiliation for this user * @param { ('outcast'|'member'|'admin'|'owner') } users[].affiliation - The new affiliation for this user
* @param { string } [users[].reason] - An optional reason for the affiliation change * @param { String } [users[].reason] - An optional reason for the affiliation change
*/ */
set (muc_jids, users) { set (muc_jids, users) {
users = !Array.isArray(users) ? [users] : users; users = !Array.isArray(users) ? [users] : users;

2
src/headless/plugins/muc/affiliations/utils.js
View File

@ -67,7 +67,7 @@ export function setAffiliations (muc_jid, users) {
* a separate stanza for each JID. * a separate stanza for each JID.
* Related ticket: https://issues.prosody.im/345 * Related ticket: https://issues.prosody.im/345
* *
* @param { String } affiliation - The affiliation * @param { ('outcast'|'member'|'admin'|'owner') } affiliation - The affiliation to be set
* @param { String|Array<String> } jids - The JID(s) of the MUCs in which the * @param { String|Array<String> } jids - The JID(s) of the MUCs in which the
* affiliations need to be set. * affiliations need to be set.
* @param { object } members - A map of jids, affiliations and * @param { object } members - A map of jids, affiliations and