feat: allow specifying error message override for duplicate key errors unique: true
#15059
+96
−11
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
Nov 26, 2024
Comment on lines
+2802
to
+2804
| /*! | ||
| * | ||
| */ |
There was a problem hiding this comment.
this should likely have docs or a ignore comment like other places
| * will still throw MongoDB's default `E11000 duplicate key error` message. | ||
| * | ||
| * @param {Boolean} value | ||
| * @param {String} message |
There was a problem hiding this comment.
Suggested change
| * @param {String} message | |
| * @param {String} [message] |
if i understand correctly, message can be optional (theoretically value could be too)
| @@ -309,7 +309,7 @@ declare module 'mongoose' { | |||
| eachPath(fn: (path: string, type: SchemaType) => void): this; | |||
|
|
|||
| /** Defines an index (most likely compound) for this schema. */ | |||
| index(fields: IndexDefinition, options?: IndexOptions): this; | |||
| index(fields: IndexDefinition, options?: Omit<IndexOptions, 'unique'> & { unique?: boolean | undefined | [true, string] }): this; | |||
There was a problem hiding this comment.
Suggested change
| index(fields: IndexDefinition, options?: Omit<IndexOptions, 'unique'> & { unique?: boolean | undefined | [true, string] }): this; | |
| index(fields: IndexDefinition, options?: Omit<IndexOptions, 'unique'> & { unique?: boolean | [true, string] }): this; |
i think this undefined can be omitted because property is already marked ?
hasezoey
added
the
enhancement
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
Allow overriding MongoDB's default "duplicate key error" message in your schemas:
This works for
save()and query methods, but does not work forbulkWrite()andinsertMany()because the duplicate key error in that case does not returnkeyPattern, which means we would either have to guess the duplicate key by the index name (brittle) or parse the index key from the error message (we would have to pull in Acorn or something like that, because duplicate key error message is not formatted as JSON).Examples