<A>(O: Order<A>): {
(options: { minimum: A; maximum: A }): (self: A) => boolean
(self: A, options: { minimum: A; maximum: A }): boolean
}Checks whether a value is between a minimum and a maximum (inclusive) according to the given order.
When to use
Use when you need range checks that respect domain-specific ordering, such as dates, versions, or custom priorities, instead of JavaScript numeric comparison.
Details
Returns true when the value is greater than or equal to minimum and less
than or equal to maximum. Values outside the range return false. Both
bounds are inclusive.
Example (Checking ranges)
import { Order } from "effect"
const betweenNumber = Order.isBetween(Order.Number)
console.log(betweenNumber(5, { minimum: 1, maximum: 10 })) // true
console.log(betweenNumber(1, { minimum: 1, maximum: 10 })) // true
console.log(betweenNumber(10, { minimum: 1, maximum: 10 })) // true
console.log(betweenNumber(0, { minimum: 1, maximum: 10 })) // false
console.log(betweenNumber(11, { minimum: 1, maximum: 10 })) // falseexport const const isBetween: <A>(O: Order<A>) => {
(options: { minimum: A; maximum: A }): (
self: A
) => boolean
(
self: A,
options: { minimum: A; maximum: A }
): boolean
}
Checks whether a value is between a minimum and a maximum (inclusive) according to the given order.
When to use
Use when you need range checks that respect domain-specific ordering, such as
dates, versions, or custom priorities, instead of JavaScript numeric
comparison.
Details
Returns true when the value is greater than or equal to minimum and less
than or equal to maximum. Values outside the range return false. Both
bounds are inclusive.
Example (Checking ranges)
import { Order } from "effect"
const betweenNumber = Order.isBetween(Order.Number)
console.log(betweenNumber(5, { minimum: 1, maximum: 10 })) // true
console.log(betweenNumber(1, { minimum: 1, maximum: 10 })) // true
console.log(betweenNumber(10, { minimum: 1, maximum: 10 })) // true
console.log(betweenNumber(0, { minimum: 1, maximum: 10 })) // false
console.log(betweenNumber(11, { minimum: 1, maximum: 10 })) // false
isBetween = <function (type parameter) A in <A>(O: Order<A>): {
(options: {
minimum: A;
maximum: A;
}): (self: A) => boolean;
(self: A, options: {
minimum: A;
maximum: A;
}): boolean;
}
type O: Order<A>O: interface Order<in A>Represents a total ordering for values of type A.
When to use
Use when you need to define how values of a type are compared.
Details
An order returns -1 when the first value is less than the second, 0 when
the values are equal according to this ordering, and 1 when the first value
is greater than the second. It must satisfy total ordering laws: totality,
antisymmetry, and transitivity.
Example (Defining a custom Order)
import { Order } from "effect"
const byAge: Order.Order<{ name: string; age: number }> = (self, that) => {
if (self.age < that.age) return -1
if (self.age > that.age) return 1
return 0
}
const person1 = { name: "Alice", age: 30 }
const person2 = { name: "Bob", age: 25 }
console.log(byAge(person1, person2)) // 1
Order<function (type parameter) A in <A>(O: Order<A>): {
(options: {
minimum: A;
maximum: A;
}): (self: A) => boolean;
(self: A, options: {
minimum: A;
maximum: A;
}): boolean;
}
options: {
minimum: A
maximum: A
}
minimum: Aminimum: function (type parameter) A in <A>(O: Order<A>): {
(options: {
minimum: A;
maximum: A;
}): (self: A) => boolean;
(self: A, options: {
minimum: A;
maximum: A;
}): boolean;
}
maximum: Amaximum: function (type parameter) A in <A>(O: Order<A>): {
(options: {
minimum: A;
maximum: A;
}): (self: A) => boolean;
(self: A, options: {
minimum: A;
maximum: A;
}): boolean;
}
self: Aself: function (type parameter) A in <A>(O: Order<A>): {
(options: {
minimum: A;
maximum: A;
}): (self: A) => boolean;
(self: A, options: {
minimum: A;
maximum: A;
}): boolean;
}
self: Aself: function (type parameter) A in <A>(O: Order<A>): {
(options: {
minimum: A;
maximum: A;
}): (self: A) => boolean;
(self: A, options: {
minimum: A;
maximum: A;
}): boolean;
}
options: {
minimum: A
maximum: A
}
minimum: Aminimum: function (type parameter) A in <A>(O: Order<A>): {
(options: {
minimum: A;
maximum: A;
}): (self: A) => boolean;
(self: A, options: {
minimum: A;
maximum: A;
}): boolean;
}
maximum: Amaximum: function (type parameter) A in <A>(O: Order<A>): {
(options: {
minimum: A;
maximum: A;
}): (self: A) => boolean;
(self: A, options: {
minimum: A;
maximum: A;
}): boolean;
}
import dualdual(
2,
(self: Aself: function (type parameter) A in <A>(O: Order<A>): {
(options: {
minimum: A;
maximum: A;
}): (self: A) => boolean;
(self: A, options: {
minimum: A;
maximum: A;
}): boolean;
}
options: {
minimum: A
maximum: A
}
minimum: Aminimum: function (type parameter) A in <A>(O: Order<A>): {
(options: {
minimum: A;
maximum: A;
}): (self: A) => boolean;
(self: A, options: {
minimum: A;
maximum: A;
}): boolean;
}
maximum: Amaximum: function (type parameter) A in <A>(O: Order<A>): {
(options: {
minimum: A;
maximum: A;
}): (self: A) => boolean;
(self: A, options: {
minimum: A;
maximum: A;
}): boolean;
}
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(type O: Order<A>O)(self: Aself, options: {
minimum: A
maximum: A
}
minimum: Aminimum) && !const isGreaterThan: <A>(O: Order<A>) => {
(that: A): (self: A) => boolean
(self: A, that: A): boolean
}
Checks whether one value is strictly greater than another according to the given order.
When to use
Use when you need a boolean greater-than predicate using an Order.
Details
Returns true if the order returns 1, meaning the first value is greater
than the second. Equal or lesser values return false.
Example (Checking greater-than comparisons)
import { Order } from "effect"
const isGreaterThanNumber = Order.isGreaterThan(Order.Number)
console.log(isGreaterThanNumber(2, 1)) // true
console.log(isGreaterThanNumber(1, 2)) // false
console.log(isGreaterThanNumber(1, 1)) // false
isGreaterThan(type O: Order<A>O)(self: Aself, options: {
minimum: A
maximum: A
}
maximum: Amaximum)
)