# new MinValidator(messageopt)
The MinValidator checks if a numeric value, date, or string is greater than or equal to a specified minimum value. It supports comparing numbers directly, dates chronologically, and strings lexicographically. This validator is typically used with the @min decorator.
Validator for checking if a value is greater than or equal to a minimum
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
string
|
<optional> |
Custom error message to display when validation fails, defaults to |
Example
```typescript
// Create a min validator with default error message
const minValidator = new MinValidator();
// Create a min validator with custom error message
const customMinValidator = new MinValidator("Value must be at least {0}");
// Validate a number
const numOptions = { min: 10, message: "Number too small" };
const numResult = minValidator.hasErrors(50, numOptions); // undefined (valid)
const invalidNumResult = minValidator.hasErrors(5, numOptions); // Returns error message (invalid)
// Validate a date
const dateOptions = { min: new Date(2023, 0, 1) };
const dateResult = minValidator.hasErrors(new Date(2023, 5, 15), dateOptions); // undefined (valid)
```Extends
Methods
# hasErrors(value, options) → {string|undefined}
Validates that the provided value is not less than the minimum value specified in the options. For dates, it performs chronological comparison, converting string representations to Date objects if necessary. For numbers and strings, it performs direct comparison.
Checks if a value is greater than or equal to a minimum
Parameters:
| Name | Type | Description |
|---|---|---|
value |
number
|
Date
|
string
|
The value to validate |
options |
MinValidatorOptions
|
Configuration options containing the minimum value |
- Overrides:
- See:
Error message if validation fails, undefined if validation passes
string
|
undefined