effect-io-ai

Package: effect
Module: BigDecimal

BigDecimal.isZero

Checks whether a given BigDecimal is 0.

When to use

Use to test whether a BigDecimal is exactly zero.

Example (Checking zero decimals)

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

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

Signature

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

Source

Since v2.0.0