fastest-validator

New custom function signature

Thanks for @erfanium, in this version there is a new signature of custom check functions.
In this new function you should always return the value. It means you can change the value, thus you can also sanitize the input value.

Old custom function:

const v = new Validator({});

const schema = {
    weight: {
        type: "custom",
        minWeight: 10,
        check(value, schema) {
            return (value < schema.minWeight)
                ? [{ type: "weightMin", expected: schema.minWeight, actual: value }]
                : true;
        }
    }
};

New custom function:

const v = new Validator({
    useNewCustomCheckerFunction: true, // using new version
});

const schema = {
    name: { type: "string", min: 3, max: 255 },
    weight: {
        type: "custom",
        minWeight: 10,
        check(value, errors, schema) {
            if (value < minWeight) errors.push({ type: "weightMin", expected: schema.minWeight, actual: value });
            if (value > 100) value = 100
            return value
        }
    }
};

Please note: the old version will be removed in the version 2.0.0!

The signature is used in custom function of built-in rules.

const v = new Validator({
    useNewCustomCheckerFunction: true // using new version
});

const schema = {
    phone: { type: "string", length: 15, custom(v, errors) => {
        if (!v.startWith("+")) errors.push({ type: "phoneNumber" })
        return v.replace(/[^\d+]/g, ""); // Sanitize: remove all special chars except numbers
    } }	
};

Changes

• Add new class rule to check the instance of value #126
• Updated typescript definitions #127 #129
• Fix deep-extend function to detect objects better. #128
• Add hex check to string rule #132

Changes

• Add default settings for built-in rules #120 by @erfanium
• Updated typescript definitions #122 by @FFKL

Changes

• New user-defined 'alias' feature #118 by @erfanium
• Add custom validation function for built-in rules #119 by @erfanium

Changes

• Fix string with a pattern where regular expression contains a double quote #111 by @FranzZemen

Changes

• fix missing field property in custom rules #109

Changes

• add unique validation in array rule #104

Changes

• fix array rule return value issue (again).

Changes

• fix optional multi rule.

Changes

• fix array rule return value issue.

The full library has been rewritten. It uses code generators in order to be much faster.

Breaking changes

This new version contains several breaking changes.

Rule logic changed

The rule codes have been rewritten to code generator functions. Therefore if you use custom validators, you should rewrite them after upgrading.

Convert values

The number, boolean and date rules have a convert: true property. In the previous version it doesn't modify the value in the checked object, just converted the value to the rules. In the version 1.0 this property converts the values in the checked object, as well.

New

Sanitizations

The sanitization function is implemented. There are several rules which contains sanitizers. Please note, the sanitizers change the original checked object values.

Root element validation

Basically the validator expects that you want to validate a Javascript object. If you want others, you can define the root level schema, as well. In this case set the $$root: true property.

Example to validate a string variable instead of object

const schema = {
    $$root: true,
    type: "string", 
    min: 3, 
    max: 6
};

v.validate("John", schema); // Valid
v.validate("Al", schema); // Fail, too short.

Enhanced shorthand types

You can use string-based shorthand validation definitions in the schema with properties.

{
    password: "string|min:6",
    age: "number|optional|integer|positive|min:0|max:99",

    retry: ["number|integer|min:0", "boolean"] // multiple types
}

Other changes

New equal rule

It checks the value equal (==) to a static value or another property. The strict property uses === to check values.

Example with static value:

const schema = {
    agreeTerms: { type: "equal", value: true, strict: true } // strict means `===`
}

v.validate({ agreeTerms: true }, schema); // Valid
v.validate({ agreeTerms: false }, schema); // Fail

Example with other field:

const schema = {
    password: { type: "string", min: 6 },
    confirmPassword: { type: "equal", field: "password" }
}

v.validate({ password: "123456", confirmPassword: "123456" }, schema); // Valid
v.validate({ password: "123456", confirmPassword: "pass1234" }, schema); // Fail

properties in object rule

You can use the properties property besides the props property in the object rule.

Changes

• update typescript definitions.
• add "actual" variable into string messages.

Changes

• add mac and luhn rules by @intech;
• update dev dependencies.
• fix custom rule custom messages issue. #83

Changes

• fix typescript definitions.
• fix strict property compilation.

Changes

• fix typescript definitions.

Changes

• fix uuid rule. #60
• fix typescript definitions. #59

Changes

• add uuid rule by @intech. #43
• fix typescript exposing by @darky. #58
• add personalised error messages per field by @ispyinternet. #57
• add strict object validation by @fabioanderegg & @mbaertschi. #47
• linting sources.

Changes

• add error message for url rule.
• add numeric attribute to string rule.
• add alpha, alphanum & alphadash attributes to string rule.
• add index.d.ts file.
• fix multiple validator with different messages issue.

Changes

• support recursive schemas by @andersnm
• fix irregular object property names

Changes

• performance improvements by @andersnm
• rewritten schema compiling by @andersnm