Skip to content

Commit

Permalink
feat(connector): add missing jsDoc descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexandre Stanislawski committed Mar 24, 2017
1 parent 9df7e7e commit e26e8e2
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
10 changes: 5 additions & 5 deletions src/connectors/star-rating/connectStarRating.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ Full documentation available at https://community.algolia.com/instantsearch.js/c

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

/**
Expand Down
14 changes: 7 additions & 7 deletions src/connectors/stats/connectStats.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ Full documentation available at https://community.algolia.com/instantsearch.js/c

/**
* @typedef {Object} StatsRenderingOptions
* @property {InstantSearch} instantSearchInstance
* @property {number} hitsPerPage
* @property {number} nbHits
* @property {number} nbPages
* @property {number} page
* @property {number} processingTimeMS
* @property {string} query
* @property {InstantSearch} instantSearchInstance the instance of instantsearch on which the widget is attached
* @property {number} hitsPerPage the number of hits per page
* @property {number} nbHits the number of hits returned by the last search results
* @property {number} nbPages the numbers of pages of results
* @property {number} page the current page
* @property {number} processingTimeMS the time taken in the Algolia engine to compute the results
* @property {string} query the last query used
*/

/**
Expand Down

0 comments on commit e26e8e2

Please sign in to comment.