feat: typed results #1527
Open
feat: typed results #1527
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
Add Query and Command classes. Thenks to that if they have a generic type we can assign it to one of its props and infer the return type of the handler using this property.
Tony133
suggested changes
Nov 12, 2023
| import { IQuery } from './query.interface'; | ||
|
|
||
| export class Query<T> implements IQuery { | ||
| resultType$f9fbca36!: T; |
There was a problem hiding this comment.
Shouldn't it be resultType: T; ? right ?
Suggested change
| resultType$f9fbca36!: T; | |
| resultType: T; |
There was a problem hiding this comment.
No, this field is made unique intentionally so no one should be surprised while creating a query like
class GetApiResponse extends Query<Response> {
resultType: string;
}
const response = queryBus.exec(new GetApiResponse({resultType: 'json'}))
in such case, the type of the response variable would be string instead of Response.
That's why @Dyostiq added a unique suffix to that necessary field.
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.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number: #490
What is the new behavior?
There is a new option to pass an instance of a class to the bus which is a generic type and from it later we can infer the return type of the handler.
The behavior is the same as with this package https://github.com/nestjs-architects/typed-cqrs
Does this PR introduce a breaking change?
It's not a breaking change to the API. It's rater an extension. However, if someone was extending or implementing the original Query/CommandBus it is a breaking change for them because they have to follow the extended interface now.
Other information