Module documentation for 0.1.1
This is a library that implements generalized approach to checking and verification of data. It’s useful, for example, for validation of fields on web forms.
Typically, there are a number of transformations and checks you may want to perform on a particular type of data, such as text. Thus, it makes sense to create all those transformations and checks once and then combine them to get more complex validators that may vary on per-field basis.
Certainly, if we can normalize and validate, we should normalize first. However, if we have many normalizing operations, we need a way to specify in which order they should be performed, or result can be unpredictable.
To specify order in which transformations are performed,
normalizerM functions take a “priority” argument, which is just a
Natural number. The bigger the number, the later the function will be
applied, so the transformation with priority 0 will always run first.
This method applies to validators just as well. It’s possible to create a vocabulary of validators that can be mixed together and the result will be always deterministic.
To support more real-world use cases, every check can be performed inside of a monad, allowing to query a database for example.
One last thing to note is that every normalizer and every validator should have a unique priority number. Normalizers (and validators) with the same priority will overwrite each other. This is by design. Note that normalizer won’t override validator with the same priority though, their priority-spaces are separate.
Copyright © 2016–2017 Mark Karpov
Distributed under BSD 3 clause license.
Data Check 0.1.1
- Minor documentation and metadata changes.
Data Check 0.1.0
- Initial release.