effect-io-ai

Package: effect
Module: Order

Order.isLessThanOrEqualTo

Checks whether one value is less than or equal to another according to the given order.

When to use

Use when you need a boolean less-than-or-equal predicate using an Order.

Details

Returns true if the order returns -1 or 0, and returns false only if the order returns 1.

Example (Checking less-than-or-equal comparisons)

import { Order } from "effect"

const isLessThanOrEqualToNumber = Order.isLessThanOrEqualTo(Order.Number)

console.log(isLessThanOrEqualToNumber(1, 2)) // true
console.log(isLessThanOrEqualToNumber(1, 1)) // true
console.log(isLessThanOrEqualToNumber(2, 1)) // false

See

• isLessThan for strict less than
• isGreaterThan for strict greater than

Signature

declare const isLessThanOrEqualTo: <A>(O: Order<A>) => { (that: A): (self: A) => boolean; (self: A, that: A): boolean; }

Source

Since v4.0.0