effect-io-ai

Package: effect
Module: BigDecimal

BigDecimal.isNegative

Checks whether a given BigDecimal is negative.

When to use

Use to test whether a BigDecimal is less than zero.

Example (Checking negative decimals)

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

assert.deepStrictEqual(BigDecimal.isNegative(BigDecimal.fromStringUnsafe("-1")), true)
assert.deepStrictEqual(BigDecimal.isNegative(BigDecimal.fromStringUnsafe("0")), false)
assert.deepStrictEqual(BigDecimal.isNegative(BigDecimal.fromStringUnsafe("1")), false)

Signature

declare const isNegative: (n: BigDecimal) => boolean

Source

Since v2.0.0