types: correct this parameter for methods with versionKey - #16344
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adjusts Mongoose’s TypeScript typings so hydrated document method types don’t retain an explicit this parameter, avoiding this-context incompatibilities that can show up when schema options like versionKey affect inferred document/model types (per #16046).
Changes:
- Introduces
HydratedDocumentOverrides<>to stripthisparameters from function-valued overrides. - Applies
HydratedDocumentOverrides<>when composingHydratedDocument<>with overrides. - Extends type tests to cover
versionKey+ methods scenarios and ensure method return types are preserved.
Reviewed changes
Copilot reviewed 2 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| types/utility.d.ts | Adds helper mapped types to omit this from function properties in overrides. |
| types/index.d.ts | Wraps HydratedDocument override composition with HydratedDocumentOverrides<>. |
| test/types/schema.test.ts | Updates the existing gh-16046 type regression to include versionKey and assert method return typing on hydrated docs. |
| test/types/models.test.ts | Adds a second gh-16046 type regression covering schema methods with custom versionKey. |
AbdelrahmanHafez
approved these changes
Jun 28, 2026
hasezoey
approved these changes
Jun 28, 2026
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
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 #16046
Summary
Omit
thisfrom methods because ofversionKeyoption handling mismatch.Schema.create()already does this with the original fix for #16046 here.Mongoose adds
thisparameter to methods withAddThisParameter<>so the method body gets type checked correctly innew Schema()(thisis correctly set to the inferred document), but then Mongoose stripsthiswhen the methods are added to the actual hydrated document type, because at that point TypeScript already knows the correct type ofthis(the actual document).Examples