diff --git a/packages/client-search/model/searchDictionaryEntriesResponse.ts b/packages/client-search/model/searchDictionaryEntriesResponse.ts index 744cd61eb..f29bc8664 100644 --- a/packages/client-search/model/searchDictionaryEntriesResponse.ts +++ b/packages/client-search/model/searchDictionaryEntriesResponse.ts @@ -9,7 +9,7 @@ export type SearchDictionaryEntriesResponse = { hits: Array; /** - * Requested page of the API response. + * Requested page of the API response. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2. */ page: number; diff --git a/packages/client-search/model/searchRulesParams.ts b/packages/client-search/model/searchRulesParams.ts index f95752470..10a71bbec 100644 --- a/packages/client-search/model/searchRulesParams.ts +++ b/packages/client-search/model/searchRulesParams.ts @@ -19,12 +19,12 @@ export type SearchRulesParams = { context?: string; /** - * Requested page of the API response. + * Requested page of the API response. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2. */ page?: number; /** - * Maximum number of hits per page. + * Maximum number of hits per page. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2. */ hitsPerPage?: number; diff --git a/packages/client-search/model/searchUserIdsResponse.ts b/packages/client-search/model/searchUserIdsResponse.ts index 7d2c934c7..498a185d5 100644 --- a/packages/client-search/model/searchUserIdsResponse.ts +++ b/packages/client-search/model/searchUserIdsResponse.ts @@ -22,7 +22,7 @@ export type SearchUserIdsResponse = { page: number; /** - * Maximum number of hits per page. + * Maximum number of hits per page. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2. */ hitsPerPage: number; diff --git a/packages/recommend/model/searchRecommendRulesParams.ts b/packages/recommend/model/searchRecommendRulesParams.ts index 1d485b586..cee2044ae 100644 --- a/packages/recommend/model/searchRecommendRulesParams.ts +++ b/packages/recommend/model/searchRecommendRulesParams.ts @@ -15,12 +15,12 @@ export type SearchRecommendRulesParams = { context?: string; /** - * Requested page of the API response. + * Requested page of the API response. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2. */ page?: number; /** - * Maximum number of hits per page. + * Maximum number of hits per page. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2. */ hitsPerPage?: number;