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

Commit 3b705dd

Browse files
authored
fix(ts): correct type for HierarchicalFacet parameter (#811)
I've checked, and the defaulting of " > " actually happens only in `_getHierarchicalFacetSeparator`, so that means you can get facets without separator. Examples: https://github.com/algolia/instantsearch.js/blob/1ede1ae392d3a12f5b0fe29075ffeb05e572a874/src/connectors/menu/connectMenu.js#L283-L286 https://github.com/algolia/instantsearch.js/blob/1ede1ae392d3a12f5b0fe29075ffeb05e572a874/src/connectors/menu/__tests__/connectMenu-test.js#L98-L101
1 parent c71f9c5 commit 3b705dd

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

index.d.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -549,7 +549,9 @@ declare namespace algoliasearchHelper {
549549
addFacet(facet: string): SearchParameters;
550550
/* Add a refinement on a "normal" facet */
551551
addFacetRefinement(facet: string, value: string): SearchParameters;
552-
addHierarchicalFacet(facet: any): SearchParameters;
552+
addHierarchicalFacet(
553+
facet: SearchParameters.HierarchicalFacet
554+
): SearchParameters;
553555
addHierarchicalFacetRefinement(
554556
facet: string,
555557
path: string
@@ -1128,7 +1130,7 @@ declare namespace algoliasearchHelper {
11281130
type HierarchicalFacet = {
11291131
name: string;
11301132
attributes: string[];
1131-
separator: string;
1133+
separator?: string;
11321134
};
11331135

11341136
type OperatorList = {

0 commit comments

Comments
 (0)