Fix: Type of Connection.transaction() #11825
Merged
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.
The documentation and code say it accepts "options" as a second parameter, but the type definition doesn't allow it.
Summary
The documentation lists Connection.prototype.transaction() as accepting an
options
parameter (and this is indeed the case), but the type definition doesn't allow it.This is particularly problematic for using this function with causally consistent sessions, given that the default read concern is
local
, because it prevents setting thereadConcern
at anything other than the client level.Examples
The sample from the documentation:
will fail to transpile as Typescript, with the error
TS2554: Expected 1 arguments, but got 2.