DaffSearchDriverInterface

The search driver is responsible for interfacing with a platform to search for entites.

import { DaffSearchDriverInterface } from '@daffodil/search/driver'

interface DaffSearchDriverInterface<T extends DaffSearchResult = DaffSearchResult> {
  search: Observable<DaffSearchDriverResponse<T>>
  incremental: Observable<DaffSearchResultCollection<T>>
}

Properties

Name	Type	Description
search	Observable<DaffSearchDriverResponse<T>>	Searches for entities according to the specified query. This method provides substantially more information than `incremental`. Its intended use is populating a page of search results.
incremental	Observable<DaffSearchResultCollection<T>>	Rapidly searches for entities. This is intended to be called as the user types their search query. Less information is requested in comparison to `search`.