Add types declaration file, update objection to ^2.2.0 #20
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
gersongams
approved these changes
Jul 11, 2020
loteoo
reviewed
Sep 30, 2020
Comment on lines
+4
to
+12
| class SDQueryBuilder<M extends Model> { | ||
| SingleQueryBuilderType: SDQueryBuilder<M>; | ||
|
|
||
| delete(): this['SingleQueryBuilderType'] & M['QueryBuilderType']['SingleQueryBuilderType']; | ||
| hardDelete(): this['SingleQueryBuilderType'] & M['QueryBuilderType']['SingleQueryBuilderType']; | ||
| undelete(): this['SingleQueryBuilderType'] & M['QueryBuilderType']['SingleQueryBuilderType']; | ||
| whereDeleted(): this['SingleQueryBuilderType'] & M['QueryBuilderType']['SingleQueryBuilderType']; | ||
| whereNotDeleted(): this['SingleQueryBuilderType'] & M['QueryBuilderType']['SingleQueryBuilderType']; | ||
| } |
There was a problem hiding this comment.
I manually used your PR in my project, but I made the types for the SDQueryBuilder class as such:
import { Model, QueryBuilder } from 'objection';
class SDQueryBuilder<M extends Model, R = M[]> extends QueryBuilder<M, R> {
ArrayQueryBuilderType!: SDQueryBuilder<M>;
NumberQueryBuilderType!: SDQueryBuilder<M, number>;
delete(): this['NumberQueryBuilderType'];
hardDelete(): this['NumberQueryBuilderType'];
undelete(): this['NumberQueryBuilderType'];
whereDeleted(): this['ArrayQueryBuilderType'];
whereNotDeleted(): this['ArrayQueryBuilderType'];
}
// And changed SDInstance to:
interface SDInstance<T extends typeof Model> {
QueryBuilderType: SDQueryBuilder<this>;
}There was a problem hiding this comment.
Looks cleaner. If it works then all's good 👍
There was a problem hiding this comment.
Just updated the comment, we didn't need the SingleQueryBuilderType and the PageQueryBuilderType so I removed them. We would need them if the plugin added methods like .findById() and .page().
.delete(), .hardDelete() and undelete() internally use .patch(), which returns the NumberQueryBuilder.
.whereDeleted() and .whereNotDeleted() internally use .where() and .whereNot(), which returns the ArrayQueryBuilder.
hayder-nativapps
approved these changes
Apr 27, 2021
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.
Resolves #17. As mentioned in the issue, updating
objectionto a more recent version is required to allow TypeScript support. It works fine from my own tests working from the code in the Readme but if there are any issues then please let me know.