Skip to content

Commit e26e8e2

Browse files
author
Alexandre Stanislawski
committed
feat(connector): add missing jsDoc descriptions
1 parent 9df7e7e commit e26e8e2

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

src/connectors/star-rating/connectStarRating.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ Full documentation available at https://community.algolia.com/instantsearch.js/c
2727

2828
/**
2929
* @typedef {Object} StarRatingRenderingOptions
30-
* @property {Object[]} items
31-
* @property {function} createURL
32-
* @property {function} refine
33-
* @property {boolean} hasNoResults
34-
* @property {InstantSearch} instantSearchInstance
30+
* @property {Object[]} items all the elements to render
31+
* @property {function} createURL a function that creates a url for the next state (takes the filter value as parameter)
32+
* @property {function} refine a function that switch to the next state and do a search (takes the filter value as parameter)
33+
* @property {boolean} hasNoResults a boolean that indicates that the last search contains no results
34+
* @property {InstantSearch} instantSearchInstance the instance of instantsearch on which the widget is attached
3535
*/
3636

3737
/**

src/connectors/stats/connectStats.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ Full documentation available at https://community.algolia.com/instantsearch.js/c
1717

1818
/**
1919
* @typedef {Object} StatsRenderingOptions
20-
* @property {InstantSearch} instantSearchInstance
21-
* @property {number} hitsPerPage
22-
* @property {number} nbHits
23-
* @property {number} nbPages
24-
* @property {number} page
25-
* @property {number} processingTimeMS
26-
* @property {string} query
20+
* @property {InstantSearch} instantSearchInstance the instance of instantsearch on which the widget is attached
21+
* @property {number} hitsPerPage the number of hits per page
22+
* @property {number} nbHits the number of hits returned by the last search results
23+
* @property {number} nbPages the numbers of pages of results
24+
* @property {number} page the current page
25+
* @property {number} processingTimeMS the time taken in the Algolia engine to compute the results
26+
* @property {string} query the last query used
2727
*/
2828

2929
/**

0 commit comments

Comments
 (0)