Type alias SearchIndex

SearchIndex: { [wordFromQuery: string]: { [matchedWord: string]: { [chapterNum: string]: number[] } } }

An object of search query matches.

The search query works by splitting the provided query into words and then processing the first 20. The first layer of the response shows each of the words that were searched for in the database. For example, if I searched for hello world, the outermost keys would be hello and world.

The sub-object of each of the outermost keys shows the results for each of the words. It will show all words that matched the given word, and these are all capitalized. For example, if I searched for world, the second object would have WORLD, WORLDWIDE, etc.

The innermost object shows the chapters that contained each of the words. Finally, the list that is the value of the innermost object shows the pages in the chapter that matched the given word.

Type declaration

  • [wordFromQuery: string]: { [matchedWord: string]: { [chapterNum: string]: number[] } }
    • [matchedWord: string]: { [chapterNum: string]: number[] }
      • [chapterNum: string]: number[]

Generated using TypeDoc