effect-io-ai

Package: effect
Module: BigDecimal

BigDecimal.sign

Determines the sign of a given BigDecimal.

Example

import * as assert from "node:assert"
import { sign, unsafeFromString } from "effect/BigDecimal"

assert.deepStrictEqual(sign(unsafeFromString("-5")), -1)
assert.deepStrictEqual(sign(unsafeFromString("0")), 0)
assert.deepStrictEqual(sign(unsafeFromString("5")), 1)

Signature

declare const sign: (n: BigDecimal) => Ordering

Source

Since v2.0.0