n4s 3.1.0 → 4.0.0-dev-e266d9

package/docs/custom.md

@@ -1,52 +0,0 @@
-# Creating Custom Rules
-
-To make it easier to reuse logic across your application, sometimes you would want to encapsulate bits of logic in rules that you can use later on, for example, "what's considered a valid email".
-
-Rules are called with the argument passed to enforce(x) followed by the arguments passed to `.yourRule(y, z)`.
-
-```js
-enforce.extend({
-  yourRule(x, y, z) {
-    return {
-      pass: true,
-      message: () => '',
-    };
-  },
-});
-```
-
-```js
-enforce.extend({
-  isValidEmail: value => value.indexOf('@') > -1,
-  hasKey: (value, key) => value.hasOwnProperty(key),
-  passwordsMatch: (passConfirm, options) =>
-    passConfirm === options.passConfirm && options.passIsValid,
-});
-
-enforce(user.email).isValidEmail();
-```
-
-## Custom rules return value
-
-Rules can either return boolean indicating success or failure, or an object with two keys. `pass` indicates whether the validation is successful or not, and message provides a function with no arguments that return an error message in case of failure. Thus, when pass is false, message should return the error message for when enforce(x).yourRule() fails.
-
-```js
-enforce.extend({
-  isWithinRange(received, floor, ceiling) {
-    const pass = received >= floor && received <= ceiling;
-    if (pass) {
-      return {
-        message: () =>
-          `expected ${received} not to be within range ${floor} - ${ceiling}`,
-        pass: true,
-      };
-    } else {
-      return {
-        message: () =>
-          `expected ${received} to be within range ${floor} - ${ceiling}`,
-        pass: false,
-      };
-    }
-  },
-});
-```

package/docs/template.md

@@ -1,53 +0,0 @@
-# Enforce templates
-
-When you have common patterns you need to repeat in multiple places, it might be simpler to store them as templates.
-
-For example, let's assume that all across our systems, a username must be a non-numeric string that's longer than 3 characters.
-
-```js
-enforce(username).isString().isNotEmpty().isNotNumeric().longerThan(3);
-```
-
-This is quite simple to understand, but if you have to keep it up-to-date in every place you validate a username, you may eventually have inconsistent or out-of-date validations.
-
-It can be beneficial in that case to keep this enforcement as a template for later use:
-
-```js
-const Username = enforce.template(
-  enforce.isString().isNotEmpty().isNotNumeric().longerThan(3)
-);
-```
-
-And then, anywhere else you can use your new `Username` template to validate usernames all across your application:
-
-```js
-Username('myUsername'); // passes
-Username('1234'); // throws
-Username('ab'); // throws
-```
-
-You can also use templates inside other compound rules, such as `shape`, `isArrayOf` ,`anyOf` or `allOf`.
-
-```js
-enforce({
-  username: 'someusername',
-}).shape({ username: Username });
-
-enforce(['user1', 'user2']).isArrayOf(Username);
-```
-
-Templates can also be nested and composited:
-
-```js
-const RequiredField = enforce.template(enforce.isNotEmpty());
-const NumericString = enforce.template(enforce.isNumeric().isString());
-
-const EvenNumeric = enforce.template(
-  RequiredField,
-  NumericString,
-  enforce.isEven()
-);
-
-EvenNumeric('10'); // pases
-EvenNumeric('1'); // throws
-```