effect-io-ai

Package: effect
Module: BigDecimal

BigDecimal.min

Returns the minimum between two BigDecimals.

When to use

Use to select the smaller of two BigDecimal values.

Example (Selecting the smaller decimal)

import { BigDecimal } from "effect"
import * as assert from "node:assert"

assert.deepStrictEqual(
  BigDecimal.min(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("3")),
  BigDecimal.fromStringUnsafe("2")
)

See

• max for selecting the larger value

Signature

declare const min: { (that: BigDecimal): (self: BigDecimal) => BigDecimal; (self: BigDecimal, that: BigDecimal): BigDecimal; }

Source

Since v2.0.0