(that: number): (self: number) => boolean
(self: number, that: number): booleanReturns a function that checks if a given number is greater than or equal to the provided one.
When to use
Use to test whether one number is greater than or equal to another.
Example (Checking greater-than-or-equal comparisons)
import { Number } from "effect"
import * as assert from "node:assert"
assert.deepStrictEqual(Number.isGreaterThanOrEqualTo(2, 3), false)
assert.deepStrictEqual(Number.isGreaterThanOrEqualTo(3, 3), true)
assert.deepStrictEqual(Number.isGreaterThanOrEqualTo(4, 3), true)export const const isGreaterThanOrEqualTo: {
(that: number): (self: number) => boolean
(self: number, that: number): boolean
}
Returns a function that checks if a given number is greater than or equal to the provided one.
When to use
Use to test whether one number is greater than or equal to another.
Example (Checking greater-than-or-equal comparisons)
import { Number } from "effect"
import * as assert from "node:assert"
assert.deepStrictEqual(Number.isGreaterThanOrEqualTo(2, 3), false)
assert.deepStrictEqual(Number.isGreaterThanOrEqualTo(3, 3), true)
assert.deepStrictEqual(Number.isGreaterThanOrEqualTo(4, 3), true)
isGreaterThanOrEqualTo: {
(that: numberthat: number): (self: numberself: number) => boolean
(self: numberself: number, that: numberthat: number): boolean
} = import orderorder.const isGreaterThanOrEqualTo: <A>(
O: Order<A>
) => {
(that: A): (self: A) => boolean
(self: A, that: A): boolean
}
Checks whether one value is greater than or equal to another according to the given order.
When to use
Use when you need a boolean greater-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 greater-than-or-equal comparisons)
import { Order } from "effect"
const isGreaterThanOrEqualToNumber = Order.isGreaterThanOrEqualTo(Order.Number)
console.log(isGreaterThanOrEqualToNumber(2, 1)) // true
console.log(isGreaterThanOrEqualToNumber(1, 1)) // true
console.log(isGreaterThanOrEqualToNumber(1, 2)) // false
isGreaterThanOrEqualTo(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)