docs: Validator.register(...) `requirement` parameter

In the Validator.register block, what does the requirement parameter represent?

Validator.register('telephone', function(value, requirement, attribute) { // requirement parameter defaults to null
  return value.match(/^\d{3}-\d{3}-\d{4}$/);
}, 'The :attribute phone number is not in the format XXX-XXX-XXXX.');

[AhmedWaelElsawy]

@mikeerickson thanks very much

[mikeerickson]

@AhmedWaelElsawy The req value will contain any information after the semicolon in custom validation rule

With a custom rule as

Validator.register("years", function (val, req, attrs) {
        console.log(val, req, attrs);
        return val.length === parseInt(req)
      });
...
const validator = new Validator({ digits: "2020" }, { digits: "years:4" });

When you call execute validator, the req parameter would be 4 in this case

====

here is a test from validatorjs project

it("should should handle numeric rule", function () {
  Validator.register("years", function (val, req, attrs) {
    return val.length === parseInt(req);
  });

  const validator = new Validator({ digits: "2020" }, { digits: "years:4" });
  expect(validator.passes()).to.be.true;
});