(that: number): (self: number) => boolean
(self: number, that: number): booleanReturns true if the first argument is less than the second, otherwise false.
When to use
Use to test whether one number is strictly less than another.
Example (Checking less-than comparisons)
import { Number } from "effect"
import * as assert from "node:assert"
assert.deepStrictEqual(Number.isLessThan(2, 3), true)
assert.deepStrictEqual(Number.isLessThan(3, 3), false)
assert.deepStrictEqual(Number.isLessThan(4, 3), false)export const const isLessThan: {
(that: number): (self: number) => boolean
(self: number, that: number): boolean
}
Returns true if the first argument is less than the second, otherwise false.
When to use
Use to test whether one number is strictly less than another.
Example (Checking less-than comparisons)
import { Number } from "effect"
import * as assert from "node:assert"
assert.deepStrictEqual(Number.isLessThan(2, 3), true)
assert.deepStrictEqual(Number.isLessThan(3, 3), false)
assert.deepStrictEqual(Number.isLessThan(4, 3), false)
isLessThan: {
(that: numberthat: number): (self: numberself: number) => boolean
(self: numberself: number, that: numberthat: number): boolean
} = import orderorder.const isLessThan: <A>(O: Order<A>) => {
(that: A): (self: A) => boolean
(self: A, that: A): boolean
}
Checks whether one value is strictly less than another according to the given order.
When to use
Use when you need a boolean less-than predicate using an Order.
Details
Returns true if the order returns -1, meaning the first value is less
than the second. Equal or greater values return false.
Example (Checking less-than comparisons)
import { Order } from "effect"
const isLessThanNumber = Order.isLessThan(Order.Number)
console.log(isLessThanNumber(1, 2)) // true
console.log(isLessThanNumber(2, 1)) // false
console.log(isLessThanNumber(1, 1)) // false
isLessThan(const Order: order.Order<number>Order instance for number values.
When to use
Use when you need to sort or compare numbers through APIs that accept an
ordering instance.
Example (Comparing numbers)
import { Number } from "effect"
console.log(Number.Order(1, 2)) // -1
console.log(Number.Order(2, 1)) // 1
console.log(Number.Order(1, 1)) // 0
Order)