Documentation for this module has not been written yet. By the time it reaches 1.0.0, it will have full documentation.
In the meantime, check out the
example.js file in the repository for a usage demonstration.
Rough notes for the future documentation are below:
Marker object that is used to denote a 'virtual property' in a path segment for a validation error; a virtual property could be any property that doesn't really exist but that is semantically treated as a separately-checked value within a validator, such as the 'key property' of an
anyProperty check, or the 'hostname property' of a parsed URL.