effect-io-ai

Package: effect
Module: BigDecimal

BigDecimal.max

Returns the maximum between two BigDecimals.

When to use

Use to select the larger of two BigDecimal values.

Example (Selecting the larger decimal)

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

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

See

• min for selecting the smaller value

Signature

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

Source

Since v2.0.0