From cf50965e9e5702cd9f97138db0f56fbb8a36828f Mon Sep 17 00:00:00 2001 From: R Midhun Suresh Date: Fri, 28 Feb 2025 17:54:06 +0530 Subject: [PATCH] Add more documentation --- src/stores/room-list-v3/RoomListStoreV3.ts | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/stores/room-list-v3/RoomListStoreV3.ts b/src/stores/room-list-v3/RoomListStoreV3.ts index c37d158f41..2904680ea8 100644 --- a/src/stores/room-list-v3/RoomListStoreV3.ts +++ b/src/stores/room-list-v3/RoomListStoreV3.ts @@ -17,6 +17,11 @@ import { RoomSkipList } from "./skip-list/RoomSkipList"; import { RecencySorter } from "./skip-list/sorters/RecencySorter"; import { AlphabeticSorter } from "./skip-list/sorters/AlphabeticSorter"; +/** + * This store allows for fast retrieval of the room list in a sorted and filtered manner. + * This is the third such implementation hence the "V3". + * This store is being actively developed so expect the methods to change in future. + */ export class RoomListStoreV3Class extends AsyncStoreWithClient { private roomSkipList?: RoomSkipList; private readonly msc3946ProcessDynamicPredecessor: boolean;