min

Validates that a numeric value meets a minimum threshold.

Import

import { minRule } from '@pliant/core';

Signature

function minRule(options: MinRuleOptions): RuleDef

Options

Option	Type	Required	Description
min	number	Yes	Minimum value (inclusive)

Error Detail

{
  code: 'min',
  min: number,    // Minimum allowed
  value: number   // Actual value
}

Examples

Basic Usage

import { createRegistry, addRules, evaluateRules, minRule } from '@pliant/core';

const registry = createRegistry();
addRules(registry, {
  price: minRule({ min: 0 })
});

// Below minimum
evaluateRules(registry, -5, { field: 'price' }, ['price']);
// { price: { code: 'min', min: 0, value: -5 } }

// Passes
evaluateRules(registry, 10, { field: 'price' }, ['price']);
// null

evaluateRules(registry, 0, { field: 'price' }, ['price']);
// null (boundary is inclusive)

Empty Values

Empty values pass validation:

evaluateRules(registry, '', { field: 'price' }, ['price']);
// null (passes)

Messages

import { createMessageResolver } from '@pliant/core';

const messages = createMessageResolver({
  min: (d) => `Must be at least ${d.min}`
});

// Currency formatting
const messages = createMessageResolver({
  min: (d) => `Minimum price is $${d.min.toFixed(2)}`
});

Common Use Cases

Price (Non-Negative)

addRules(registry, {
  price: minRule({ min: 0 })
});

Quantity (At Least 1)

addRules(registry, {
  quantity: minRule({ min: 1 })
});

Age

addRules(registry, {
  age: minRule({ min: 18 })
});

const messages = createMessageResolver({
  min: 'You must be at least 18 years old'
});

Minimum Order

addRules(registry, {
  orderTotal: minRule({ min: 25 })
});

const messages = createMessageResolver({
  min: (d) => `Minimum order is $${d.min}`
});

See Also

• max — Maximum value
• range — Both min and max
• Built-in Rules — All rules