Interface Index

Hierarchy

Index

Index

Methods

Methods

delete

delete(): Promise<void>

- Defined in search/index.ts:35
Deletes the current search index

Returns Promise<void>

queryStringSearch

queryStringSearch(queryString: string): Promise<SearchResult>

- Defined in search/index.ts:24
Executes a search with the using a query string to search over the data.

Parameters
- queryString: string
  
  The query string that will be used to search over the index.
Returns Promise<SearchResult>
A Promise resolving with the search results as a string

search

search(term: string): Promise<SearchResult>

- Defined in search/index.ts:17
Executes a search with the search term over the data.

Parameters
- term: string
  
  The term that will be used to search over the index.
Returns Promise<SearchResult>
A Promise resolving with the search results as a string

update

update(documents: search.Document[], config: search.Config): Promise<void>

- Defined in search/index.ts:31
Updates the data and configuration for the data

Parameters
- documents: search.Document[]
  
  The data that will be indexed and searchable
- config: search.Config
  
  The configuration object defines how the index will preform certain searches
Returns Promise<void>

Generated using TypeDoc