Add types for Client.queryWithMetrics #628
Merged
Conversation
This file contains hidden or 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
doom-weaver
previously requested changes
Mar 29, 2022
doom-weaver
reviewed
Mar 29, 2022
Co-authored-by: Cleve Stuart <[email protected]>
doom-weaver
approved these changes
Mar 29, 2022
Akryum
reviewed
Mar 29, 2022
| export default class Client { | ||
| constructor(opts?: ClientConfig) | ||
| query<T = object>(expr: ExprArg, options?: QueryOptions): Promise<T> | ||
| query<T = object>(expr: ExprArg, options?: QueryOptions): Promise<T> | Promise<MetricsResponse<T>> |
There was a problem hiding this comment.
This is a breaking change for TypeScript projects :(
There was a problem hiding this comment.
Example:
error TS2322: Type 'boolean | MetricsResponse<boolean>' is not assignable to type 'boolean'.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
#625 did not add types for the Client class.