add comment to make clear that RoomStateEvent.Events does not update …

…related objects in the js-sdk (#4152) Signed-off-by: Timo K <[email protected]>
matrix-org · Apr 17, 2024 · 4fc6ba8 · 4fc6ba8
1 parent c30e498
commit 4fc6ba8
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/models/room-state.ts b/src/models/room-state.ts
@@ -78,6 +78,8 @@ export enum RoomStateEvent {
 export type RoomStateEventHandlerMap = {
     /**
      * Fires whenever the event dictionary in room state is updated.
+     * This does not guarantee that any related objects (like RoomMember) have been updated.
+     * Use RoomStateEvent.Update for that.
      * @param event - The matrix event which caused this event to fire.
      * @param state - The room state whose RoomState.events dictionary
      * was updated.