Skip to content

Commit 3b284de

Browse files
author
Alexandre Stanislawski
committed
feat(connector): jsDoc connectPagination
1 parent f83022a commit 3b284de

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

src/connectors/pagination/connectPagination.js

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

2626
/**
2727
* @typedef PaginationRenderingOptions
28-
* @property {function} createURL
29-
* @property {number} currentPage
30-
* @property {number} nbHits
31-
* @property {number} nbPages
32-
* @property {function} setPage
28+
* @property {function(number)} createURL create URL's for the next state, the number is the page to generate the URL for
29+
* @property {number} currentPage the number of the page currently displayed
30+
* @property {number} nbHits the number of hits computed for the last query (can be approximated)
31+
* @property {number} nbPages the number of pages for the result set
32+
* @property {function} setPage set the current page and trigger a search
3333
* @property {Object} widgetParams all original options forwarded to rendering
3434
*/
3535

3636
/**
3737
* Connects a rendering function with the pagination business logic.
38-
* @param {function(PaginationRenderingOptions)} renderFn function that renders the pagination widget
38+
* @param {function(PaginationRenderingOptions, boolean)} renderFn function that renders the pagination widget
3939
* @return {function(CustomPaginationWidgetOptions)} a widget factory for pagination widget
4040
*/
4141
export default function connectPagination(renderFn) {

0 commit comments

Comments
 (0)