types: make SchemaType static setters property accessible in TypeScript
#14881
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
Sep 11, 2024
types/schematypes.d.ts
Outdated
| @@ -216,6 +216,9 @@ declare module 'mongoose' { | |||
| /** Attaches a getter for all instances of this schema type. */ | |||
| static get(getter: (value: any) => any): void; | |||
|
|
|||
| /** Array containing default setters for all instances of this SchemaType */ | |||
| static setters: Function[]; | |||
There was a problem hiding this comment.
Suggested change
| static setters: Function[]; | |
| static setters: ((val?: unknown) => unknown)[]; |
i think it is better with known arguments, unless there are more arguments?
There was a problem hiding this comment.
Yes, there's technically 4 arguments: val, priorVal, doc, options. I'll fix.
This was referenced Oct 3, 2024
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 #14879
Summary
There are places in the docs where we recommend pushing default setters to schematypes like
mongoose.Schema.String.setters.push(fn), but TypeScript types currently don't support that.Examples