fix(index.d.ts): improve typings for virtuals #10350
Merged
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
|
These types are based on the following pages from mongoose docs: |
vkarpov15
reviewed
Jun 15, 2021
|
|
||
| /** Adds a custom getter to this virtual. */ | ||
| // eslint-disable-next-line @typescript-eslint/ban-types | ||
| get(fn: Function): this; | ||
| get(fn: (this: D, value: any, virtual: this, doc: D) => any): this; |
There was a problem hiding this comment.
Unfortunately I had to undo these changes. For some reason adding this generic param breaks defining new Schema() without a doc type and then using that schema for discriminator().
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.
Summary
Created
VirtualTypeOptionsinterface, improvedVirtualTypeclass and adjustedSchemamethods related to virtuals.Examples
I added a test file in
test/typescript/virtuals.ts.