fix!: update findOne and deleteAll semantics #244
Merged
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
Also modified ESLint config.
Also unpublish some domain model types to avoid API maintenance responsibilties.
The option connection is of no longer use in CRUD operations; only in runInTransaction.
This operation now returns an arbitrary existing entity (if any)
FindAllOptions.sortBy and filters attribute from FindOneOptions, FindAllOptions, and DeleteAllOptions used to be of type 'any' . Now devs will experience TS errors when they do not provide valid values.
Josuto
changed the title
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.
What is the purpose of this pull request?
Put an "X" next to item:
[ ] Documentation update
[ ] Bug fix
[ ] New feature
[x] Other, please explain: Change on operation semantics
What changes did you make?
Updated the semantics of
findOneanddeleteAll, so that in the absence of thefiltersproperty in theoptionsparameter, these operations find an arbitrary entity and delete all existing entities, respectively. These changes are motivated by the semantics of counterpart operations in Mongoose. Furthermore, we want the signatures of these operations to convey with others e.g.,findAllspecifyfiltersas part of itsoptionsoptional parameter.Moreover, we also removed
connectionfromTransactionOptions, since it is no longer of use to any CRUD operation specified at any abstract repository implementation. It is however kept for the only function requiring it:runInTransaction.Which issue (if any) does this pull request address?
Is there anything you'd like reviewers to focus on?