fix(pagination): allow nested keys in sortBy pagination params utility type PE-7428 #343
+751
−711
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
fedellen
commented
Jan 14, 2025
•
fedellen
commented
dtfiedler
reviewed
Jan 14, 2025
src/types/io.ts
Outdated
Comment on lines
34
to
42
| type NestedKeys<T> = T extends object | ||
| ? T extends readonly unknown[] // Detect arrays precisely | ||
| ? never // Exclude arrays | ||
| : { | ||
| [K in keyof T & string]: T[K] extends object | ||
| ? `${K}.${NestedKeys<T[K]>}` | K | ||
| : K; | ||
| }[keyof T & string] | ||
| : never; |
dtfiedler
reviewed
Jan 14, 2025
dtfiedler
reviewed
Jan 15, 2025
| @@ -302,7 +302,8 @@ export function paginationParamsFromOptions<O extends PaginationCLIOptions>( | |||
| return { | |||
| cursor, | |||
| limit: numberLimit, | |||
| sortBy, | |||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any | |||
| sortBy: sortBy as any, | |||
There was a problem hiding this comment.
nit: does unknown work better here? otherwise you can provide another type to the generic and do a SortBy on it.
dtfiedler
reviewed
Jan 15, 2025
| it('should be able to get a page of gateways sorted by nested key like `weights.compositeWeight`', async () => { | ||
| const gateways = await ario.getGateways({ | ||
| limit: 3, | ||
| sortBy: 'weights.compositeWeight', |
dtfiedler
approved these changes
Jan 15, 2025
dtfiedler
force-pushed
the
pagination-type-fix
branch
from
1a3df69 to
b06369b
Compare
|
got an issue here in the tests, don't merge yet -- will come back to this after some airdrop eventing cycles |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.