vtypes-size

"size" validation for validate.js

• About
• Installation
• Usage
• Available Options
• License

About

The size validator attempts to ensure that the size property of a value is correct.

It is similar to the length validator of validate.js, but addresses the case where values use value.size instead of value.length.

This happens mostly with immutable.js objects.

Installation

Using npm:

$ npm i --save vtypes-size

const validate = require('validate.js');
const size = require('vtypes-size');

// you can then proceed to register the required validators.
validate.validators.size = size;

Usage

const Immutable = require('immutable')

const constraints = {
  key1: {size: {is: 1}},
  key2: {size: {minimum: 1}},
  key3: {size: {maximum: 1}}
};

validate({}, constraints);
// => undefined

const values = {
  key1: new Immutable.List([]),
  key2: new Immutable.List([]),
  key3: new Immutable.List(['foo', 'bar'])
};

validate(values, constraints);
// => {
//   "key1": ["Key1 is the wrong length (should be 1)"],
//   "key2": ["Key2 is too short (minimum is 1)"],
//   "key3": ["Key3 is too long (maximum is 3)"]
// }

For more examples, check out the test files in this package's source folder.

Available Options

name	type	default	description
is	integer		Size should be the defined value
maximum	integer		Size should not be more than the defined value
minimum	integer		Size should not be less than the defined value
message	string		Error message
tooLong	string	is too long (maximum is %{count})	Error message when size is beyond maximum
tooShort	string	is too short (minimum is %{count})	Error message when size is below minimum
wrongSize	string	is the wrong size (should be %{count})	Error message when size is not equal to expected

License

vtypes-size is MIT licensed