Skip to content

Commit ea26b26

Browse files
refactor(specs): extract results field in a dedicated directory (generated)
algolia/api-clients-automation#5739 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Clara Muller <5667350+ClaraMuller@users.noreply.github.com>
1 parent 1ddd1b4 commit ea26b26

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

packages/composition/model/searchHits.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ export type SearchHits<T = Record<string, unknown>> = Record<string, any> & {
99
hits: Hit<T>[];
1010

1111
/**
12-
* Search query.
12+
* The search query string.
1313
*/
1414
query: string;
1515

packages/composition/model/searchPagination.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
export type SearchPagination = {
44
/**
5-
* Page of search results to retrieve.
5+
* The current page of the results.
66
*/
77
page: number;
88

@@ -17,7 +17,7 @@ export type SearchPagination = {
1717
nbPages: number;
1818

1919
/**
20-
* Number of hits per page.
20+
* Number of hits returned per page.
2121
*/
2222
hitsPerPage: number;
2323
};

0 commit comments

Comments
 (0)