EventIndex: Document the return value of the isValidEvent method.

This commit is contained in:
Damir Jelić 2020-02-18 14:45:03 +01:00
parent 59f8b4f6b1
commit 156c6b8db8

View file

@ -247,6 +247,8 @@ export default class EventIndex extends EventEmitter {
* or aren't of a type that we know how to index. * or aren't of a type that we know how to index.
* *
* @param {MatrixEvent} ev The event that should checked. * @param {MatrixEvent} ev The event that should checked.
* @returns {bool} Returns true if the event can be indexed, false
* otherwise.
*/ */
isValidEvent(ev) { isValidEvent(ev) {
const validEventType = ([ const validEventType = ([