Type alias SearchParams

SearchParams: Query & Pagination & Highlight & Crop & {
    attributesToRetrieve?: string[];
    attributesToSearchOn?: string[] | null;
    distinct?: string;
    facetName?: string;
    facetQuery?: string;
    facets?: string[];
    filter?: Filter;
    hitsPerPage?: number;
    hybrid?: HybridSearch;
    locales?: Locale[];
    matchingStrategy?: MatchingStrategies;
    page?: number;
    rankingScoreThreshold?: number;
    retrieveVectors?: boolean;
    showMatchesPosition?: boolean;
    showRankingScore?: boolean;
    showRankingScoreDetails?: boolean;
    sort?: string[];
    vector?: number[] | null;
}

Type declaration

  • Optional attributesToRetrieve?: string[]
  • Optional attributesToSearchOn?: string[] | null
  • Optional distinct?: string
  • Optional facetName?: string
  • Optional facetQuery?: string
  • Optional facets?: string[]
  • Optional filter?: Filter
  • Optional hitsPerPage?: number
  • Optional hybrid?: HybridSearch
  • Optional locales?: Locale[]
  • Optional matchingStrategy?: MatchingStrategies
  • Optional page?: number
  • Optional rankingScoreThreshold?: number
  • Optional retrieveVectors?: boolean
  • Optional showMatchesPosition?: boolean
  • Optional showRankingScore?: boolean
  • Optional showRankingScoreDetails?: boolean
  • Optional sort?: string[]
  • Optional vector?: number[] | null

Settings

Member Visibility

Theme