TurboFirestoreSearchApi<T> extension

Extension that adds search operations to TurboFirestoreApi

Provides methods for searching documents in Firestore

Features:

  • Text-based search
  • Numeric search
  • Array containment search
  • Prefix matching
  • Type-safe results
  • Result limiting

Example:

final api = TurboFirestoreApi<User>();
final response = await api.listBySearchTerm(
  searchTerm: 'John',
  searchField: 'name',
  searchTermType: TurboSearchTermType.startsWith,
);

See also: TurboFirestoreListApi list operations TurboFirestoreGetApi single document retrieval

on

Methods

listBySearchTerm({required String searchTerm, required String searchField, required TurboSearchTermType searchTermType, bool doSearchNumberEquivalent = false, int? limit}) Future<TurboResponse<List<Map<String, dynamic>>>>

Available on TurboFirestoreApi<T>, provided by the TurboFirestoreSearchApi extension

Searches for documents matching a search term
listBySearchTermWithConverter({required String searchTerm, required String searchField, required TurboSearchTermType searchTermType, bool doSearchNumberEquivalent = false, int? limit}) Future<TurboResponse<List<T>>>

Available on TurboFirestoreApi<T>, provided by the TurboFirestoreSearchApi extension

Searches for documents with type conversion