Skip to content
This repository was archived by the owner on May 1, 2025. It is now read-only.

fix(akita): restrict usage of sortByOrder to valid usages in type system#667

Open
cgrabmann wants to merge 1 commit intosalesforce:masterfrom
cgrabmann:sortBy_types
Open

fix(akita): restrict usage of sortByOrder to valid usages in type system#667
cgrabmann wants to merge 1 commit intosalesforce:masterfrom
cgrabmann:sortBy_types

Conversation

@cgrabmann
Copy link

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

When using getAll or selectAll from a QueryEntity and providing a sortBy function, the sortByOrder is ignored. This is not represented in the type system and therefore lead to some initial confusion in our team.

Issue Number: N/A

What is the new behavior?

sortByOrder can no longer be provided when providing a sortBy function. This is now restricted by the type system.
image

sortByOrder can can still be provided when providing a sortBy field.
image

Does this PR introduce a breaking change?

  • Yes
  • No

Projects that provided a sortByOrder and a sortBy function will have a failing build and need to remove the sortByOrder

Other information

@NetanelBasal
Copy link
Collaborator

Thanks, we'll merge it in v7

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments