Skip to content

Commit 6637c3d

Browse files
authored
Add deprecation notice (#185)
1 parent ce80dd1 commit 6637c3d

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

src/hooks/usePagination.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,20 @@ import useRequestConfigs from './useRequestConfigs';
33

44
export interface UsePaginationProps {
55
/**
6+
* **⚠️ Deprecation Notice ⚠️**
7+
*
8+
* _This field will be deprecated in v2._
9+
* _If you're looking to change the number of items requested please use `staticRequestConfigs` instead._
10+
*
611
* Total number of results returned by the API response
712
*/
813
totalNumResults: number;
914
/**
15+
* **⚠️ Deprecation Notice ⚠️**
16+
*
17+
* _This field will be deprecated in v2._
18+
* _If you're looking to change the number of items requested please use `staticRequestConfigs` instead._
19+
*
1020
* Number of results returned per page
1121
*/
1222
resultsPerPage?: number;

0 commit comments

Comments
 (0)