(that: number): (self: number) => number
(self: number, that: number): numberReturns the minimum between two numbers.
When to use
Use to select the smaller of two numbers.
Example (Finding the minimum)
import { Number } from "effect"
import * as assert from "node:assert"
assert.deepStrictEqual(Number.min(2, 3), 2)export const const min: {
(that: number): (self: number) => number
(self: number, that: number): number
}
Returns the minimum between two numbers.
When to use
Use to select the smaller of two numbers.
Example (Finding the minimum)
import { Number } from "effect"
import * as assert from "node:assert"
assert.deepStrictEqual(Number.min(2, 3), 2)
min: {
(that: numberthat: number): (self: numberself: number) => number
(self: numberself: number, that: numberthat: number): number
} = import orderorder.const min: <A>(O: Order<A>) => {
(that: A): (self: A) => A
(self: A, that: A): A
}
Returns the minimum of two values according to the given order. If they are equal, returns the first argument.
When to use
Use when you need to select the smaller of two values according to an
Order.
Details
Returns the value that compares as less than or equal to the other value. If
values are equal, the first argument is returned.
Example (Selecting the minimum value)
import { Order } from "effect"
const minNumber = Order.min(Order.Number)
console.log(minNumber(1, 2)) // 1
console.log(minNumber(2, 1)) // 1
console.log(minNumber(1, 1)) // 1
min(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)