self-assert/dist/rule-requirements/numbers/NumbersRequirements.d.ts

A small TypeScript library for designing models with built-in validity.

import type { Predicate } from "../Requirements";
export declare class NumbersRequirements {
    /**
     * Returns a predicate that is `true` if the value is greater than the given number
     * @function @category Numbers
     */
    static greaterThan: (aNumber: number) => Predicate<number>;
    /**
     * Returns a predicate that is `true` if the value is greater than or equal to the given number
     * @function @category Numbers
     */
    static greaterThanOrEqual: (aNumber: number) => Predicate<number>;
    /**
     * Returns a predicate that is `true` if the value is less than the given number
     * @function @category Numbers
     */
    static lessThan: (aNumber: number) => Predicate<number>;
    /**
     * Returns a predicate that is `true` if the value is less than or equal to the given number
     * @function @category Numbers
     */
    static lessThanOrEqual: (aNumber: number) => Predicate<number>;
    /**
     * Returns a predicate that is `true` if the value is between two numbers (inclusive)
     * @function @category Numbers
     */
    static between: (min: number, max: number) => Predicate<number>;
    /**
     * Returns a predicate that is `true` if the value is an integer
     * @function @category Numbers
     */
    static isInteger: (number: unknown) => boolean;
    /**
     * Returns a predicate that is `true` if the value is a float
     * @function @category Numbers
     */
    static isFloat: Predicate<unknown>;
    /**
     * Returns a predicate that is `true` if the value is positive
     * @function @category Numbers
     */
    static isPositive: Predicate<number>;
    /**
     * Returns a predicate that is `true` if the value is negative
     * @function @category Numbers
     */
    static isNegative: Predicate<number>;
    /**
     * Returns a predicate that is `true` if the value is a positive integer
     * @function @category Numbers
     */
    static isPositiveInteger: Predicate<number>;
    /**
     * Returns a predicate that is `true` if the value is a negative integer
     * @function @category Numbers
     */
    static isNegativeInteger: Predicate<number>;
    /**
     * Returns a predicate that is `true` if the value is an integer between two numbers (inclusive)
     * @function @category Numbers
     */
    static isIntegerBetween: (min: number, max: number) => Predicate<number>;
}
//# sourceMappingURL=NumbersRequirements.d.ts.map