UNPKG

data-validators

Version:

Validators that help make sure your data follow specific constraints.

github.com/c-butcher/data-validators

c-butcher/data-validators

51 lines (40 loc) • 2.61 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
## Length Validator Checks to make sure that a values length falls within a certain range. ### Options | Name | Required | Type | Description | |---------|----------|---------|-------------------------------------| | min | Yes | number | The minimum length of the value | | max | Yes | number | The maximum length of the value | | message | No | string | Explanation of the validation error | ## Contains Validator Checks to make sure that the value contains what we're matching. ### Options | Name | Required | Type | Description | |-------------|----------|-----------------|------------------------------------------------| | match | Yes | string, number | The value that we're trying to match. | | insensitive | No | boolean | Tells whether to do a case-insensitive search. | | message | No | string | Explanation of the validation error | ## Range Validator Checks to make sure that a value falls within a certain range. ### Options | Name | Required | Type | Description | |---------|----------|--------------|-------------------------------------| | min | Yes | number, date | The lowest boundary of the range | | max | Yes | number, date | The highest boundary of the range | | message | No | string | Explanation of the validation error | ## Choice Validator Checks to make sure that a value falls within a specific set of acceptable values. ### Options | Name | Required | Type | Description | |----------------|----------|---------|---------------------------------------------------------------| | values | Yes | array | List of the acceptable values | | insensitive | No | boolean | Tells whether to do a case-insensitive search | | containsValue | No | boolean | Only passes validation when the supplied value is in our list | | message | No | string | Explanation of the validation error | ## Zip Code Validator Checks to make sure that a value follows the zip code format. _Example_: `23551` or `23551-1234` ### Options | Name | Required | Type | Description | |---------|----------|---------------|-------------------------------------| | message | No | string | Explanation of the validation error |