types(model): fix type of options of Model.aggregate #12933
Merged
+10
−63
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.
Summary
This change adjusts the type of the
options
parameter ofModel.aggregate
to be theAggregateOptions
type from mongoose, instead of the one from mongodb. The aggregate method just passes this parameter on toAggregate.option
, which is already typed to accept theAggregateOptions
type from mongoose, so this seems like the correct choice.The 2 types mostly seem to be compatible anyways, but there is a small inconsistency that makes them incompatible:
mongodb.AggregateOptions
specifies that thesession
property may be aClientSession
, orundefined
(but notnull
), while theAggregateOptions
type from mongoose also allowsnull
. So maybe that also should simply be aligned.