Skip to content

Commit 3028fe9

Browse files
committed
Improve room documentation
1 parent 0b970b0 commit 3028fe9

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

src/models/room.js

+10-1
Original file line numberDiff line numberDiff line change
@@ -1823,7 +1823,7 @@ Room.prototype.getAccountData = function(type) {
18231823

18241824

18251825
/**
1826-
* Returns wheter the syncing user has permission to send a message in the room
1826+
* Returns whether the syncing user has permission to send a message in the room
18271827
* @return {boolean} true if the user should be permitted to send
18281828
* message events into the room.
18291829
*/
@@ -2073,3 +2073,12 @@ function memberNamesToRoomName(names, count = (names.length + 1)) {
20732073
*
20742074
* @param {EventStatus} oldStatus The previous event status.
20752075
*/
2076+
2077+
/**
2078+
* Fires when the logged in user's membership in the room is updated.
2079+
*
2080+
* @event module:models/room~Room#"Room.myMembership"
2081+
* @param {Room} room The room in which the membership has been updated
2082+
* @param {string} membership The new membership value
2083+
* @param {string} prevMembership The previous membership value
2084+
*/

0 commit comments

Comments
 (0)