aurelia / aurelia/documentation

Validation satisfies() `config` argument is not documented

Open
#323 2 comments 0 reactions 2 assignees Claimed by @dkent600 View on GitHub
documentation help wanted
Dominant language
No language data
Stars
104
Forks
108
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.