EventIndex: Document the return value of the isValidEvent method.

2020-02-18 14:45:03 +01:00 · 2020-02-18 14:45:03 +01:00 · 156c6b8db8
commit 156c6b8db8
parent 59f8b4f6b1
1 changed files with 2 additions and 0 deletions
--- a/src/indexing/EventIndex.js
+++ b/src/indexing/EventIndex.js
@ -247,6 +247,8 @@ export default class EventIndex extends EventEmitter {
     * or aren't of a type that we know how to index.
     *
     * @param {MatrixEvent} ev The event that should checked.
+     * @returns {bool} Returns true if the event can be indexed, false
+     * otherwise.
     */
    isValidEvent(ev) {
        const validEventType = ([