min - Strickland

Search…
min
The min validator checks that a numeric value is at least the minimum value provided.
If the value being validated is null, false, an empty string, or another falsy value other than 0, then the result will be valid. This respects the rule of thumb described in the notes for the required validator.
Named Props
min: The minimum value compared against
Parameters
The min validator supports three parameter signatures:
1.min(value) where the value is used as the min named prop
2.min(propsObject) where the props object contains a min named prop
3.min(propsFunction) where the props function returns a props object with a min named prop
Usage
1
import validate, {min} from 'strickland';
2
​
3
// As a value parameter
4
const minOf3 = min(3);
5
​
6
// As a named prop
7
const minOf2 = min({
8
    min: 2,
9
    message: 'Must be at least 2'}
10
);
11
​
12
// As a function that resolves to have the named prop
13
const minValidator = min((context) => ({
14
    min: context.min,
15
    message: `Must be at least ${context.min}`
16
}));
Copied!
compare
max
Last modified 1yr ago
Copy link
Contents
Named Props
Parameters
Usage