Skip to main content

Type alias: FirestoreTextSearchController

Ƭ FirestoreTextSearchController: (props: { path: string ; searchString: string }) => Promise<readonly string[]> | undefined

Use this controller to return a list of ids from a search index, given a path and a searchString. Firestore does not support text search directly so we need to rely on an external index, such as Algolia. Note that you will get text search requests for collections that have the textSearchEnabled flag set to true.

see performAlgoliaTextSearch

Type declaration#

▸ (props): Promise<readonly string[]> | undefined

Parameters#
NameType
propsObject
props.pathstring
props.searchStringstring
Returns#

Promise<readonly string[]> | undefined

Defined in#

firebase_app/models/text_search.ts:13