Skip to content

types(schema): use user-provided THydratedDocumentType as context for virtual get() and set() #15517

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vkarpov15 merged 2 commits into from
Jul 7, 2025
Merged

types(schema): use user-provided THydratedDocumentType as context for virtual get() and set() #15517

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a59dc00
types(schema): use user-provided THydratedDocumentType as context for…
vkarpov15 Jul 5, 2025
7421c27
fix lint
vkarpov15 Jul 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions test/types/schema.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1841,3 +1841,17 @@ function gh15479() {
return obj.testField;
}
}

function gh15516() {
interface IUser {
name: string;
}
type HydratedUserDoc = HydratedDocument<IUser & { customProperty: number, myVirtual: number }>;
const schema = new Schema<IUser, Model<IUser>, {}, {}, { myVirtual: number }, {}, DefaultSchemaOptions, any, HydratedUserDoc>({
name: String
});

schema.virtual('myVirtual').get(function() {
expectType<HydratedUserDoc>(this);
});
}
2 changes: 1 addition & 1 deletion types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -519,7 +519,7 @@ declare module 'mongoose' {
toJSONSchema(options?: { useBsonType?: boolean }): Record<string, any>;

/** Creates a virtual type with the given name. */
virtual<T = HydratedDocument<DocType, TVirtuals & TInstanceMethods, TQueryHelpers>>(
virtual<T = THydratedDocumentType>(
name: keyof TVirtuals | string,
options?: VirtualTypeOptions<T, DocType>
): VirtualType<T>;
Expand Down