Skip to content

Commit f83022a

Browse files
author
Alexandre Stanislawski
committed
feat(connector): update jsDoc descriptions
1 parent ee9fb11 commit f83022a

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/connectors/price-ranges/connectPriceRanges.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,15 @@ Full documentation available at https://community.algolia.com/instantsearch.js/c
2424

2525
/**
2626
* @typedef {Object} PriceRangesRenderingOptions
27-
* @property {Object[]} items
28-
* @property {function} refine
27+
* @property {Object[]} items the prices ranges to display
28+
* @property {function} refine select or unselect a price range and trigger a search
2929
* @property {Object} widgetParams all original options forwarded to rendering
3030
* @property {InstantSearch} instantSearchInstance
3131
*/
3232

3333
/**
3434
* Connects a rendering function with the price ranges business logic.
35-
* @param {function(PriceRangesRenderingOptions)} renderFn function that renders the price ranges widget
35+
* @param {function(PriceRangesRenderingOptions, boolean)} renderFn function that renders the price ranges widget
3636
* @return {function(CustomPriceRangesWidgetOptions)} a widget factory for price ranges widget
3737
*/
3838
export default function connectPriceRanges(renderFn) {

0 commit comments

Comments
 (0)