imterah/element-portable
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

EventIndex: Improve the documentation a bit.

Browse source
This commit is contained in:
Damir Jelić 2020-01-28 15:06:43 +01:00
parent a168461e8b
commit 0b7f23fa54
2 changed files with 107 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

4
src/indexing/BaseEventIndexManager.js
View file

@ -153,8 +153,8 @@ export default class BaseEventIndexManager {
/**
* Search the event index using the given term for matching events.
*
* @param {SearchArgs} searchArgs The search configuration sets what should
* be searched for and what should be contained in the search result.
* @param {SearchArgs} searchArgs The search configuration for the search,
* sets the search term and determines the search result contents.
*
* @return {Promise<[SearchResult]>} A promise that will resolve to an array
* of search results once the search is done.