effect-io-ai

Package: effect
Module: BigDecimal

BigDecimal.isBigDecimal

Checks whether a given value is a BigDecimal.

When to use

Use to validate unknown input and narrow it to BigDecimal.

Example (Checking BigDecimal values)

import { BigDecimal } from "effect"

const decimal = BigDecimal.fromNumber(123.45)
console.log(BigDecimal.isBigDecimal(decimal)) // true
console.log(BigDecimal.isBigDecimal(123.45)) // false
console.log(BigDecimal.isBigDecimal("123.45")) // false

Signature

declare const isBigDecimal: (u: unknown) => u is BigDecimal

Source

Since v2.0.0