aurelia / documentation

The documentation for Aurelia.
MIT License
105 stars 110 forks source link

Validation satisfies() `config` argument is not documented #323

Open dkent600 opened 7 years ago

dkent600 commented 7 years ago

Validation satisfies config parameter is not documented. Should be something to the effect:

The optional config parameter is an object that will be included in the context available to formatted validation messages. For example: the default maxLength validation message uses the config object like this:

"${$displayName} cannot be longer than ${$config.length} character${$config.length === 1 ? '' : 's'}.

Note that customRule documents it this way:

The config object is used when computing the validation message when an error occurs, enabling the message expression to access the rule's configuration.

EisenbergEffect commented 7 years ago

Interested in submitting a PR for the doc update?

dkent600 commented 7 years ago

Will do