(options: { minimum: number; maximum: number }): (self: number) => boolean
(self: number, options: { minimum: number; maximum: number }): booleanChecks whether a number is between a minimum and maximum value (inclusive).
When to use
Use to test whether a number falls inside an inclusive range.
Example (Checking inclusive ranges)
import { Number } from "effect"
import * as assert from "node:assert"
const between = Number.between({ minimum: 0, maximum: 5 })
assert.deepStrictEqual(between(3), true)
assert.deepStrictEqual(between(-1), false)
assert.deepStrictEqual(between(6), false)export const const between: {
(options: {
minimum: number
maximum: number
}): (self: number) => boolean
(
self: number,
options: {
minimum: number
maximum: number
}
): boolean
}
Checks whether a number is between a minimum and maximum value (inclusive).
When to use
Use to test whether a number falls inside an inclusive range.
Example (Checking inclusive ranges)
import { Number } from "effect"
import * as assert from "node:assert"
const between = Number.between({ minimum: 0, maximum: 5 })
assert.deepStrictEqual(between(3), true)
assert.deepStrictEqual(between(-1), false)
assert.deepStrictEqual(between(6), false)
between: {
(options: {
minimum: number
maximum: number
}
minimum: numberminimum: number
maximum: numbermaximum: number
}): (self: numberself: number) => boolean
(self: numberself: number, options: {
minimum: number
maximum: number
}
minimum: numberminimum: number
maximum: numbermaximum: number
}): boolean
} = import orderorder.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(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)