> For the complete documentation index, see [llms.txt](https://www.strickland.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.strickland.io/built-in-validators/min.md).

# 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](/built-in-validators/required.md) 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

```jsx
import validate, {min} from 'strickland';

// As a value parameter
const minOf3 = min(3);

// As a named prop
const minOf2 = min({
    min: 2,
    message: 'Must be at least 2'}
);

// As a function that resolves to have the named prop
const minValidator = min((context) => ({
    min: context.min,
    message: `Must be at least ${context.min}`
}));
```
