Interface: ISearchApi
Defined in: Api/ISearchApi.ts:10
Unified search operations — text search, semantic search, saved searches.
Future: Search methods should accept an optional PassageRange[] to limit results by book, testament, or arbitrary verse ranges. Keyword search can filter via SQL WHERE; semantic search may need post-retrieval filtering.
Methods
buildIndex()
buildIndex(
module):Promise<void>
Defined in: Api/ISearchApi.ts:19
Parameters
module
string
Returns
Promise<void>
clearSearchHistory()
clearSearchHistory():
Promise<void>
Defined in: Api/ISearchApi.ts:36
Returns
Promise<void>
deleteSavedSearch()
deleteSavedSearch(
savedSearchId):Promise<void>
Defined in: Api/ISearchApi.ts:29
Parameters
savedSearchId
number
Returns
Promise<void>
getIndexStatus()
getIndexStatus(
module):Promise<IndexStatus>
Defined in: Api/ISearchApi.ts:18
Parameters
module
string
Returns
Promise<IndexStatus>
getSavedSearches()
getSavedSearches():
Promise<object[]>
Defined in: Api/ISearchApi.ts:22
Returns
Promise<object[]>
getSearchHistory()
getSearchHistory(
limit?):Promise<object[]>
Defined in: Api/ISearchApi.ts:32
Parameters
limit?
number
Returns
Promise<object[]>
isSemanticSearchAvailable()
isSemanticSearchAvailable():
Promise<boolean>
Defined in: Api/ISearchApi.ts:39
Returns
Promise<boolean>
performSearch()
performSearch(
query,modules,options?):Promise<SearchResult>
Defined in: Api/ISearchApi.ts:12
Parameters
query
string
modules
string[]
options?
limit?
number
offset?
number
Returns
Promise<SearchResult>
saveSearch()
saveSearch(
name,query,modules):Promise<number>
Defined in: Api/ISearchApi.ts:28
Parameters
name
string
query
string
modules
string[]
Returns
Promise<number>
semanticSearch()
semanticSearch(
query,options?):Promise<VerseSearchResult[]>
Defined in: Api/ISearchApi.ts:40
Parameters
query
string
options?
limit?
number
threshold?
number
Returns
Promise<VerseSearchResult[]>