ngrx-forms/validation/src/greater-than.d.ts

Proper integration of forms in Angular 4 applications using ngrx

import { Boxed, ValidationErrors } from 'ngrx-forms';
export interface GreaterThanValidationError {
    comparand: number;
    actual: number;
}
declare module 'ngrx-forms' {
    interface ValidationErrors {
        greaterThan?: GreaterThanValidationError;
    }
}
/**
 * A validation function that requires the value to be greater than a number.
 * Considers `null`, `undefined` and non-numeric values as valid. Combine this function with the `required`
 * validation function if `null` or `undefined` should be considered invalid.
 *
 * The validation error returned by this validation function has the following shape:
 *
```typescript
{
  greaterThan: {
    comparand: number;
    actual: number;
  };
}
```
 *
 * Usually you would use this validation function in conjunction with the `validate`
 * update function to perform synchronous validation in your reducer:
 *
```typescript
updateGroup<MyFormValue>({
  amount: validate(greaterThan(10)),
})
```
 *
 * Note that this function is generic to allow the compiler to properly infer the type
 * of the `validate` function for both optional and non-optional controls.
 */
export declare function greaterThan(comparand: number): <T extends number | Boxed<number> | null | undefined>(value: T) => ValidationErrors;