Skip to content

types: make SchemaType static setters property accessible in TypeScript #14881

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
merged 2 commits into from
Sep 11, 2024
Merged

types: make SchemaType static setters property accessible in TypeScript #14881

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c7f7273
types: make SchemaType static `setters` property accessible in TypeSc…
vkarpov15 Sep 10, 2024
60541e7
types: add function args to setters property
vkarpov15 Sep 11, 2024
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
Next Next commit
types: make SchemaType static setters property accessible in TypeSc… 
…ript

Fix #14879
  • Loading branch information
@vkarpov15
vkarpov15 committed Sep 10, 2024
commit c7f72739436acc09b46220aacd72274f0bb10f96
4 changes: 4 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 @@ -1634,3 +1634,7 @@ function gh14825() {
type SchemaType = InferSchemaType<typeof schema>;
expectAssignable<User>({} as SchemaType);
}

function gh14879() {
Schema.Types.String.setters.push((val?: unknown) => typeof val === 'string' ? val.trim() : val);
}
3 changes: 3 additions & 0 deletions types/schematypes.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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[];
Copy link
Collaborator

@hasezoey hasezoey Sep 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
static setters: Function[];
static setters: ((val?: unknown) => unknown)[];

i think it is better with known arguments, unless there are more arguments?

Copy link
Collaborator Author

@vkarpov15 vkarpov15 Sep 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, there's technically 4 arguments: val, priorVal, doc, options. I'll fix.


/** The class that Mongoose uses internally to instantiate this SchemaType's `options` property. */
OptionsConstructor: SchemaTypeOptions<T>;

Expand Down