From cc2ee53824b955e513def52cf4a08118d853e646 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Damir=20Jeli=C4=87?= <poljar@termina.org.uk>
Date: Wed, 13 Nov 2019 16:21:26 +0100
Subject: [PATCH] EventIndex: Add some more docs and fix some lint issues.

---
 src/BaseEventIndexManager.js          |  2 +-
 src/BasePlatform.js                   |  6 ++++++
 src/EventIndexPeg.js                  | 20 ++++++++++++++++----
 src/components/structures/RoomView.js |  2 +-
 4 files changed, 24 insertions(+), 6 deletions(-)

diff --git a/src/BaseEventIndexManager.js b/src/BaseEventIndexManager.js
index a74eac658a..48a96c4d88 100644
--- a/src/BaseEventIndexManager.js
+++ b/src/BaseEventIndexManager.js
@@ -168,7 +168,7 @@ export default class BaseEventIndexManager {
     async addHistoricEvents(
         events: [HistoricEvent],
         checkpoint: CrawlerCheckpoint | null = null,
-        oldCheckpoint: CrawlerCheckpoint | null  = null,
+        oldCheckpoint: CrawlerCheckpoint | null = null,
     ): Promise<bool> {
         throw new Error("Unimplemented");
     }
diff --git a/src/BasePlatform.js b/src/BasePlatform.js
index 582ac24cb0..f6301fd173 100644
--- a/src/BasePlatform.js
+++ b/src/BasePlatform.js
@@ -153,6 +153,12 @@ export default class BasePlatform {
         throw new Error("Unimplemented");
     }
 
+    /**
+     * Get our platform specific EventIndexManager.
+     *
+     * @return {BaseEventIndexManager} The EventIndex manager for our platform,
+     * can be null if the platform doesn't support event indexing.
+     */
     getEventIndexingManager(): BaseEventIndexManager | null {
         return null;
     }
diff --git a/src/EventIndexPeg.js b/src/EventIndexPeg.js
index 3ce88339eb..1b380e273f 100644
--- a/src/EventIndexPeg.js
+++ b/src/EventIndexPeg.js
@@ -34,16 +34,16 @@ class EventIndexPeg {
     /**
      * Get the current event index.
      *
-     * @Returns The EventIndex object for the application. Can be null
-     * if the platform doesn't support event indexing.
+     * @return {EventIndex} The current event index.
      */
     get() {
         return this.index;
     }
 
     /** Create a new EventIndex and initialize it if the platform supports it.
-     * Returns true if an EventIndex was successfully initialized, false
-     * otherwise.
+     *
+     * @return {Promise<bool>} A promise that will resolve to true if an
+     * EventIndex was successfully initialized, false otherwise.
      */
     async init() {
         const indexManager = PlatformPeg.get().getEventIndexingManager();
@@ -71,15 +71,27 @@ class EventIndexPeg {
         return true;
     }
 
+    /**
+     * Stop our event indexer.
+     */
     stop() {
         if (this.index === null) return;
         this.index.stop();
         this.index = null;
     }
 
+    /**
+     * Delete our event indexer.
+     *
+     * After a call to this the init() method will need to be called again.
+     *
+     * @return {Promise} A promise that will resolve once the event index is
+     * deleted.
+     */
     async deleteEventIndex() {
         if (this.index === null) return;
         this.index.deleteEventIndex();
+        this.index = null;
     }
 }
 
diff --git a/src/components/structures/RoomView.js b/src/components/structures/RoomView.js
index 9fe54ad164..6dee60bec7 100644
--- a/src/components/structures/RoomView.js
+++ b/src/components/structures/RoomView.js
@@ -1131,7 +1131,7 @@ module.exports = createReactClass({
         this.searchId = new Date().getTime();
 
         let roomId;
-        if (scope === "Room") roomId = this.state.room.roomId,
+        if (scope === "Room") roomId = this.state.room.roomId;
 
         debuglog("sending search request");
         const searchPromise = eventSearch(term, roomId);