Skip to content
This repository was archived by the owner on Jul 11, 2023. It is now read-only.

Commit 236822e

Browse files
author
Eunjae Lee
authored
fix(ts): add types for smart sort (#809)
* fix(ts): add types for smart sort * chore: update comments
1 parent 67ad89b commit 236822e

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

index.d.ts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -511,6 +511,13 @@ declare namespace algoliasearchHelper {
511511
ruleContexts?: string[];
512512
optionalFilters?: Array<string | string[]>;
513513
queryLanguages?: string[];
514+
515+
/**
516+
* The relevancy threshold to apply to search in a virtual index [0-100]. A Bigger
517+
* value means fewer, but more relevant results, smaller value means more, but
518+
* less relevant results.
519+
*/
520+
relevancyStrictness?: number;
514521
}
515522

516523
export class SearchParameters implements PlainSearchParameters {
@@ -1156,6 +1163,14 @@ declare namespace algoliasearchHelper {
11561163
* total number of hits of this query on the index
11571164
*/
11581165
nbHits: number;
1166+
/**
1167+
* subset of hits selected when relevancyStrictness is applied
1168+
*/
1169+
nbSortedHits?: number;
1170+
/**
1171+
* the relevancy threshold applied to search in a virtual index
1172+
*/
1173+
appliedRelevancyStrictness?: number;
11591174
/**
11601175
* total number of pages with respect to the number of hits per page and the total number of hits
11611176
*/

0 commit comments

Comments
 (0)