Skip to content

Commit 23dc1e3

Browse files
committed
Improve comments of params builder
1 parent 7a3f37a commit 23dc1e3

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

src/adapter/search-request-adapter/search-params-adapter.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,14 @@ import {
66
} from './geo-rules-adapter'
77
import { adaptFilters } from './filter-adapter'
88

9+
/**
10+
* Builder to creates an object containing all the search query parameters
11+
* provided by the search context of instantsearch.js and instant-meilisearch.
12+
*
13+
* @param {SearchContext} searchContext
14+
*
15+
* @returns {MeiliSearchParams}
16+
*/
917
function ParamsBuilder(searchContext: SearchContext) {
1018
const meiliSearchParams: Record<string, any> = {}
1119

0 commit comments

Comments
 (0)