GitHub

DaffSearchDriverInterface

Type

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

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

interface DaffSearchDriverInterface<T extends DaffSearchResult = DaffSearchResult> {
  search(
    query: string
    options?: DaffSearchDriverOptions
  ): any
  incremental(
    query: string
    options?: DaffSearchDriverOptions
  ): any
}

() Methods

search
any

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.

Parameters
Parameterquery: string
Description
Parameteroptions: DaffSearchDriverOptions
Description
incremental
any

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.

Parameters
Parameterquery: string
Description
Parameteroptions: DaffSearchDriverOptions
Description