❤
npm
Sign UpSign In

flash-validate

0.5.2 • Public • Published

Key features

  • Very fast (faster than fastest-validator)
  • As good as a hand-coded validation function!
  • Nested object & array handling
  • Multiple validators
  • Customizable error messages (coming soon)
  • Programmable error object (coming soon)
  • No dependencies
  • Unit tests & near 100% cover

How fast?

About 2.5 times faster than fastest-validator in it's simple benchmark. For more complex structures with nested objects and values it should be about 1.5 to 2 times faster than fastest-validator. In any case, many thanks to fastest-validator for it served as the basis for this project!

Platform info:
==============
   Darwin 17.2.0 x64
   Node.JS: 9.5.0
   V8: 6.2.414.46-node.18
   Intel(R) Core(TM) i7-4850HQ CPU @ 2.30GHz × 8

Suite: Simple object
✔ compile & validate                        7,377,252 rps
✔ validate with pre-compiled schema         8,744,150 rps
✔ validate with wrong obj                   8,356,860 rps

Installation

You can install it via NPM.

$ npm install flash-validate --save

or

$ yarn add flash-validate

Usage

There are two ways to use flash-validate: the simple method and the fast method.

Simple method

Call the validate method with the object and the schema.

If the performance is important, you should pre-compile the schema first.

const Validator = require("flash-validate"),
      v = new Validator()

const schema = {
    id: { type: "number", positive: true, integer: true },
    name: { type: "string", min: 3, max: 255 },
    status: "boolean"
}

console.log(v.validate({ id: 5, name: "John", status: true }, schema))
// Outputs: true

console.log(v.validate({ id: 5, name: "Al", status: true }, schema))
/* Outputs an error object:
    { 
        type: 'stringMin',
        expected: 3,
        actual: 2,
        field: 'name',
        message: 'The \'name\' field length must be larger than or equal to 3 characters long!'
    }
*/

Fast method

We begin by compiling the schema into a native function, which can be then be used without the schema argument.

You gain about 20% performance this way.

const Validator = require("fastest-validator"),
      v = new Validator()

const schema = {
    id: { type: "number", positive: true, integer: true },
    name: { type: "string", min: 3, max: 255 },
    status: "boolean"
}

var validate = v.compile(schema);

console.log(validate({ id: 5, name: "John", status: true }));
// Outputs: true

console.log(validate({ id: 2, name: "Adam" }));
/* Outputs an error object::
    { 
        type: 'required',
        field: 'status',
        message: 'The \'status\' field is required!'
    }
*/

Optional & required fields

Every fields in the schema will be required field. If you would like to define optional fields, set optional: true.

let schema = {
    name: { type: "string" }, // required
    age: { type: "number", optional: true }
}

v.validate({ name: "John", age: 42 }, schema); // Valid
v.validate({ name: "John" }, schema); // Valid
v.validate({ age: 42 }, schema); // Fail

Multiple validators

It's possible to multiple validators for a field. If any of the schemas validates, the field will validate.

let schema = {
    cache: [
        { type: "string" },
        { type: "boolean" }
    ]
}

v.validate({ cache: true }, schema); // Valid
v.validate({ cache: "redis://" }, schema); // Valid
v.validate({ cache: 150 }, schema); // Fail

Built-in validators

any

This is not validate the type of value. Accept any types.

let schema = {
    prop: { type: "any" }
}

v.validate({ prop: true }, schema); // Valid
v.validate({ prop: 100 }, schema); // Valid
v.validate({ prop: "John" }, schema); // Valid

array

This is an Array validator.

Simple example with strings:

let schema = {
    roles: { type: "array", items: "string" }
}

v.validate({ roles: ["user"] }, schema); // Valid
v.validate({ roles: [] }, schema); // Valid
v.validate({ roles: "user" }, schema); // Fail

Example with only positive number:

let schema = {
    list: { type: "array", min: 2, items: {
        type: "number", positive: true, integer: true
    } }
}

v.validate({ list: [2, 4] }, schema); // Valid
v.validate({ list: [1, 5, 8] }, schema); // Valid
v.validate({ list: [1] }, schema); // Fail (min 2 elements)
v.validate({ list: [1, -7] }, schema); // Fail (negative number)

Example with object list:

let schema = {
    users: { type: "array", items: {
        type: "object", props: {
            id: { type: "number", positive: true },
            name: { type: "string", empty: false },
            status: "boolean"
        }
    } }
}

v.validate({ 
    users: [
        { id: 1, name: "John", status: true },
        { id: 2, name: "Jane", status: true },
        { id: 3, name: "Bill", status: false }
    ]
}, schema); // Valid

Properties

Property Default Description
empty false If false, the validator will not accepts an empty array [].
min null Minimum count of elements.
max null Maximum count of elements.
length null Fix count of elements.
contains null The array must contains this element too.
enum null Every element must be an element of the enum array.

Example for enum:

let schema = {
    roles: { type: "array", items: "string", enum: [ "user", "admin" ] }
}

v.validate({ roles: ["user"] }, schema); // Valid
v.validate({ roles: ["user", "admin"] }, schema); // Valid
v.validate({ roles: ["guest"] }, schema); // Fail

boolean

This is a Boolean validator.

let schema = {
    status: { type: "boolean" }
}

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

Properties

Property Default Description
convert false if true and the type is not Boolean, try to convert. 1, "true", "1", "on" will be true. 0, "false", "0", "off" will be false.

date

This is a Date validator.

let schema = {
    dob: { type: "date" }
}

v.validate({ dob: new Date() }, schema); // Valid
v.validate({ dob: new Date(1488876927958) }, schema); // Valid
v.validate({ dob: 1488876927958 }, schema); // Fail

Properties

Property Default Description
convert false if true and the type is not Date, try to convert with new Date().

email

This is an e-mail address validator.

let schema = {
    email: { type: "email" }
}

v.validate({ email: "john.doe@gmail.com" }, schema); // Valid
v.validate({ email: "james.123.45@mail.co.uk" }, schema); // Valid
v.validate({ email: "abc@gmail" }, schema); // Fail

Properties

Property Default Description
mode quick Checker method. Can be quick or precise.

forbidden

This validator gives error if the property is exists in the object.

let schema = {
    password: { type: "forbidden" }
}

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

function

The type of value must be Function.

let schema = {
    show: { type: "function" }
}

v.validate({ show: function() {} }, schema); // Valid
v.validate({ show: Date.now }, schema); // Valid
v.validate({ show: null }, schema); // Fail

number

This is a number validator. The type of value must be Number.

let schema = {
    age: { type: "number" }
}

v.validate({ age: 123 }, schema); // Valid
v.validate({ age: 5.65 }, schema); // Valid
v.validate({ age: "100" }, schema); // Fail

Properties

Property Default Description
min null Minimum value.
max null Maximum value.
equal null Fix value.
notEqual null Can't be equal with this value.
integer false The value must be a non-decimal value.
positive false The value must be larger than zero.
negative false The value must be less than zero.
convert false if true and the type is not Number, try to convert with parseFloat.

object

This is a nested object validator.

let schema = {
    address: { type: "object", props: {
        country: { type: "string" },
        city: "string", // short-hand
        zip: "number" // short-hand
    } }
}

v.validate({ 
    address: {
        country: "Italy",
        city: "Rome",
        zip: 12345
    } 
}, schema); // Valid

v.validate({ 
    address: {
        country: "Italy",
        city: "Rome"
    }
}, schema); // Fail ("The 'address.zip' field is required!")

string

This is a string validator. The type of value must be String.

let schema = {
    name: { type: "string" }
}

v.validate({ name: "John" }, schema); // Valid
v.validate({ name: "" }, schema); // Valid
v.validate({ name: 123 }, schema); // Fail

Properties

Property Default Description
empty true If true, the validator accepts empty string "".
min null Minimum length of value.
max null Maximum length of value.
length null Fix length of value.
pattern null Regex pattern.
contains null The value must contains this text.
enum null The value must be an element of the enum array.

url

This is an URL validator.

let schema = {
    url: { type: "url" }
}

v.validate({ url: "http://google.com" }, schema); // Valid
v.validate({ url: "https://github.com/icebob" }, schema); // Valid
v.validate({ url: "www.facebook.com" }, schema); // Fail

Message types

flash-validate uses the same message structure as fastest-validator.

Name Default text
required The '{field}' field is required!
string The '{field}' field must be a string!
stringEmpty The '{field}' field must not be empty!
stringMin The '{field}' field length must be larger than or equal to {expected} characters long!
stringMax The '{field}' field length must be less than or equal to {expected} characters long!
stringLength The '{field}' field length must be {expected} characters long!
stringPattern The '{field}' field fails to match the required pattern!
stringContains The '{field}' field must contain the '{expected}' text!
stringEnum The '{field}' field does not match any of the allowed values!
number The '{field}' field must be a number!
numberMin The '{field}' field must be larger than or equal to {expected}!
numberMax The '{field}' field must be less than or equal to {expected}!
numberEqual The '{field}' field must be equal with {expected}!
numberNotEqual The '{field}' field can't be equal with {expected}!
numberInteger The '{field}' field must be an integer!
numberPositive The '{field}' field must be a positive number!
numberNegative The '{field}' field must be a negative number!
array The '{field}' field must be an array!
arrayEmpty The '{field}' field must not be an empty array!
arrayMin The '{field}' field must contain at least {expected} items!
arrayMax The '{field}' field must contain less than or equal to {expected} items!
arrayLength The '{field}' field must contain {expected} items!
arrayContains The '{field}' field must contain the '{expected}' item!
arrayEnum The '{field} field value '{expected}' does not match any of the allowed values!
boolean The '{field}' field must be a boolean!
function The '{field}' field must be a function!
date The '{field}' field must be a Date!
dateMin The '{field}' field must be larger than or equal to {expected}!
dateMax The '{field}' field must be less than or equal to {expected}!
forbidden The '{field}' field is forbidden!
email The '{field}' field must be a valid e-mail!

Message fields

Name Description
field Name of field
expected The expected value of field
actual The actual value of field
type Type of field

Coverage report

-----------------|----------|----------|----------|----------|-------------------|
File             |  % Stmts | % Branch |  % Funcs |  % Lines | Uncovered Line #s |
-----------------|----------|----------|----------|----------|-------------------|
All files        |    95.47 |    93.42 |    96.77 |    95.34 |                   |
 lib             |    85.25 |    78.13 |    90.91 |    84.21 |                   |
  assembler.js   |    85.25 |    78.13 |    90.91 |    84.21 |... 11,112,113,122 |
 lib/generators  |     98.9 |     97.5 |      100 |    98.88 |                   |
  alternative.js |    88.24 |    66.67 |      100 |     87.5 |             48,51 |
  any.js         |      100 |      100 |      100 |      100 |                   |
  array.js       |      100 |    97.06 |      100 |      100 |               100 |
  boolean.js     |      100 |      100 |      100 |      100 |                   |
  date.js        |      100 |      100 |      100 |      100 |                   |
  email.js       |      100 |      100 |      100 |      100 |                   |
  forbidden.js   |      100 |      100 |      100 |      100 |                   |
  function.js    |      100 |      100 |      100 |      100 |                   |
  number.js      |      100 |      100 |      100 |      100 |                   |
  object.js      |      100 |      100 |      100 |      100 |                   |
  optional.js    |      100 |      100 |      100 |      100 |                   |
  string.js      |      100 |      100 |      100 |      100 |                   |
  url.js         |      100 |      100 |      100 |      100 |                   |
-----------------|----------|----------|----------|----------|-------------------|

Thanks

Many thanks to fastest-validator! Lot's of ideas were for this project were directly taken from there.

Contribution

Please send pull requests improving the usage and fixing bugs, improving documentation and providing better examples, or providing some testing, because these things are important.

License

flash-validate is available under the MIT license.

Readme

Keywords

none

Package Sidebar

Install

npm i flash-validate

Weekly Downloads

5

Version

0.5.2

License

MIT

Unpacked Size

162 kB

Total Files

38

Last publish

Collaborators

  • macprog-guy
Try on RunKit
Report malware