Hyperlinkv0.8.0-beta.28

BigDecimal

BigDecimal.isNegativeconsteffect/BigDecimal.ts:1652
(n: BigDecimal): boolean

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)
predicates
export const isNegative = (n: BigDecimal): boolean => n.value < bigint0
Referenced by 3 symbols