@lokalise/api-common
Advanced tools
Comparing version 3.2.4 to 3.2.5
@@ -34,7 +34,7 @@ import { OptionalPaginationParams, PaginatedResponse, PaginationMeta } from './apiSchemas'; | ||
* | ||
* @param page - Current page of objects which will be included in `data`. | ||
* @param page - Current page of objects which will be included in `data`. It will be sliced to pageLimit if provided | ||
* @param pageLimit - An optional number that can be used to specify the expected count of items in the current page. | ||
* - If it is provided and page length is less than or equal to pageLimit, it means that there are no more items to fetch. | ||
* In that case, hasMore flag will be set to false. Otherwise, hasMore flag will be set to true. | ||
* If currentPageData length is greater than pageLimit, count will be set to pageLimit. | ||
* If currentPageData length is greater than pageLimit, it will be sliced and count will be set to pageLimit. | ||
* - If the parameter is not provided, hasMore flag will be undefined. | ||
@@ -82,3 +82,3 @@ * @param cursorKeys - An optional array of keys that determine the formation of the cursor. By default, this uses | ||
* @example | ||
* <caption>Example of usage with limit</caption> | ||
* <caption>Example of usage with limit</caption> | ||
* await getPaginatedEntries({ limit: 1 }, (params) => { | ||
@@ -88,3 +88,3 @@ * return market.getApples(params) | ||
* | ||
* <caption>Example of usage with limit and start cursor</caption> | ||
* <caption>Example of usage with limit and start cursor</caption> | ||
* await getPaginatedEntries({ limit: 1, after: 'red' }, (params) => { | ||
@@ -91,0 +91,0 @@ * return market.getApples(params) |
{ | ||
"name": "@lokalise/api-common", | ||
"version": "3.2.4", | ||
"version": "3.2.5", | ||
"files": [ | ||
@@ -36,3 +36,3 @@ "dist" | ||
"peerDependencies": { | ||
"zod": "^3.22.0" | ||
"zod": "^3.23.8" | ||
}, | ||
@@ -43,7 +43,7 @@ "devDependencies": { | ||
"@lokalise/package-vite-config": "latest", | ||
"@vitest/coverage-v8": "^1.4.0", | ||
"prettier": "3.2.5", | ||
"@vitest/coverage-v8": "^1.6.0", | ||
"prettier": "3.3.2", | ||
"rimraf": "^5.0.5", | ||
"typescript": "5.4.5", | ||
"vite": "^5.2.12", | ||
"vite": "^5.3.2", | ||
"vitest": "^1.6.0" | ||
@@ -50,0 +50,0 @@ }, |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
56020