Merge pull request #84 from GW2Treasures/feature/page-size

Allow specifying `page_size` without `page` for paginated endpoints
GW2Treasures · Nov 1, 2024 · 143c8dc · 143c8dc
2 parents 0147397 + 83dfeed
commit 143c8dc
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/.changeset/chilly-snakes-behave.md b/.changeset/chilly-snakes-behave.md
@@ -0,0 +1,5 @@
+---
+"@gw2api/types": patch
+---
+
+Allow specifying `page_size` without `page` for paginated endpoints
diff --git a/packages/types/endpoints.ts b/packages/types/endpoints.ts
@@ -339,7 +339,7 @@ type WithParameters<Url extends string, Parameters extends string | undefined =
   Parameters extends undefined ? Url : `${Url}?${Parameters}`;
 
 // helper for paginated endpoints
-type PaginationParameters = `page=${number}` | CombineParameters<`page=${number}`, `page_size=${number}`>;
+type PaginationParameters = `page=${number}` | `page_size=${number}` | CombineParameters<`page=${number}`, `page_size=${number}`>;
 type PaginatedEndpointUrl<Endpoint extends KnownEndpoint> = Endpoint | WithParameters<Endpoint, PaginationParameters>
 
 // helper types for bulk requests