Type alias SearchFunction<SearchData, SearchResult>

SearchFunction<SearchData, SearchResult>: ((searchData, options) => Promise<SearchResults<SearchResult>>)

The signature of the search function required by components that use the LisSearchMixin mixin.

Type Parameters

SearchData
The type of data that will be given to the search function.
SearchResult
The type that is expected to be in the results array of the SearchResults instance resolved by the Promise returned by the search function.

Type declaration

- (searchData, options): Promise<SearchResults<SearchResult>>
- Parameters
  - searchData: SearchData
    The data that should be used to perform a search.
  - options: SearchOptions
    Optional parameters that aren't required to perform a search but may be useful.
  Returns Promise<SearchResults<SearchResult>>

Generated using TypeDoc