types: make init hooks types accurately reflect runtime behavior
#15331
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
hasezoey
approved these changes
Mar 28, 2025
hasezoey
reviewed
Mar 28, 2025
Comment on lines
-696
to
-739
| schema.pre(['save', 'init'], function() { | ||
| expectType<HydratedDocument<IDocument>>(this); | ||
| }); | ||
|
|
||
| schema.post(['save', 'init'], function(res) { | ||
| expectType<HydratedDocument<IDocument>>(this); | ||
| expectNotType<Query<any, any>>(res); | ||
| }); | ||
|
|
||
| schema.pre(['save', 'init'], { document: true, query: false }, function() { | ||
| expectType<HydratedDocument<IDocument>>(this); | ||
| }); | ||
|
|
||
| schema.post(['save', 'init'], { document: true, query: false }, function(res) { | ||
| expectType<HydratedDocument<IDocument>>(this); | ||
| expectNotType<Query<any, any>>(res); | ||
| }); | ||
|
|
||
| schema.pre(['save', 'init'], { document: true, query: true }, function() { | ||
| expectType<HydratedDocument<IDocument>>(this); | ||
| }); | ||
|
|
||
| schema.post(['save', 'init'], { document: true, query: true }, function(res) { | ||
| expectType<HydratedDocument<IDocument>>(this); | ||
| expectNotType<Query<any, any>>(res); | ||
| }); | ||
|
|
||
| schema.pre(['save', 'init'], { document: false, query: true }, function() { | ||
| expectType<never>(this); | ||
| }); | ||
|
|
||
| schema.post(['save', 'init'], { document: false, query: true }, function(res) { | ||
| expectType<never>(this); | ||
| expectNotType<Query<any, any>>(res); | ||
| }); | ||
|
|
||
| schema.pre(['save', 'init'], { document: false, query: false }, function() { | ||
| expectType<never>(this); | ||
| }); | ||
|
|
||
| schema.post(['save', 'init'], { document: false, query: false }, function(res) { | ||
| expectType<never>(this); | ||
| expectNotType<Query<any, any>>(res); | ||
| }); |
There was a problem hiding this comment.
I didnt write about this before, but should those maybe also be restored for just save-array case? (which is possible, though weird and should likely not be used)
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.
Fix #15301
Summary
Init hooks are special because they are synchronous, so there's no
nextcallback. Also, the first parameter toinithooks is the raw data being hydrated, not the hydrated Mongoose document. This PR fixes that, although in the interest of caution it might be better to put this change in a minor release. WDYT @hasezoey ?Examples