Fixed default message formatter (closes #41) #42
Conversation
|
Thanks for your help! As I understand this, it enables users to override the default message, something impossible when you use |
|
Correct. I don't specify a message in my schema but want to modify a
global default so that's why. Also we should still support a custom
message per schema prop because people may customize as they need.
…On Aug 8, 2017 6:57 AM, "Mattéo Delabre ✏️" ***@***.***> wrote:
Thanks for your help! As I understand this, it enables users to override
the default message, something impossible when you use
mongoose.Error.messages.general.unique? However, I can’t see the use case
for having two ways of overriding the default (in the Schema and in the
options). Do you have an example where this is useful?
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#42 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AAf7hQEthXEChtL5X0GJS1E5rtkpt8lwks5sWD8dgaJpZM4OwS7A>
.
|
|
@matteodelabre can you take a look at this? ty |
index.js
Outdated
| var tree = schema.tree, key, messages = {}; | ||
|
|
||
| options = options || {}; | ||
| if (!options.message) { | ||
| options.message = 'Path `{PATH}` ({VALUE}) is not unique.'; |
There was a problem hiding this comment.
To avoid confusion between the different ways to provide a custom error message, I suggest using options.defaultMessage instead of options.message.
index.js
Outdated
| * @return {Promise.<ValidationError>} Beautified error message | ||
| */ | ||
| function beautify(error, collection, values, messages) { | ||
| function beautify(error, collection, values, messages, message) { |
There was a problem hiding this comment.
I think we should rename message to defaultMessage to avoid confusion between the singular message and the plural messages variable.
README.md
Outdated
|
|
||
| The default value of `mongoose.Error.messages.general.unique` is ``"Path `{PATH}` ({VALUE}) is not unique."`` which adheres to [the Mongoose error message defaults](https://github.com/Automattic/mongoose/blob/master/lib/error/messages.js). | ||
| The default value of `options.message` is ``"Path `{PATH}` ({VALUE}) is not unique."`` which adheres to [the Mongoose error message defaults](https://github.com/Automattic/mongoose/blob/master/lib/error/messages.js). |
There was a problem hiding this comment.
If we are going to introduce more API surface, I think we should be extra-clear on when one mechanism for overriding the message should be used instead of the other one. Currently, I have the feeling that options.message and the custom message in the unique field might feel redundant to the users.
In my opinion, the main use for options.message is for when the plugin is used globally. If you want to, I can try to improve the docs after merging this PR. I think renaming options.message to options.defaultMessage will make things clearer.
|
@matteodelabre if I change |
|
We can always wrap that line if it becomes too long. I don’t think it’s clear enough for users that these are default options. No worries, I will make those changes by myself! :) |
|
What do you think? |
|
Looks good to me |
No description provided.