tiny-types/src/predicates/isGreaterThanOrEqualTo.ts

A tiny library that brings Tiny Types to JavaScript and TypeScript

import { isEqualTo } from './isEqualTo';
import { isGreaterThan } from './isGreaterThan';
import { or } from './or';
import { Predicate } from './Predicate';

/**
 * @desc Ensures that the `value` is greater than or equal to the `lowerBound`.
 *
 * @example
 * import { ensure, isGreaterThanOrEqualTo, TinyType } from 'tiny-types';
 *
 * class AgeInYears extends TinyType {
 *     constructor(public readonly value: number) {
 *         ensure('Age in years', value, isGreaterThanOrEqualTo(18));
 *     }
 * }
 *
 * @param {number} lowerBound
 * @returns {Predicate<number>}
 */
export function isGreaterThanOrEqualTo(lowerBound: number): Predicate<number> {
    return or(isEqualTo(lowerBound), isGreaterThan(lowerBound));
}