effect 3.10.18 → 3.11.0

package/dist/dts/BigDecimal.d.ts

@@ -64,10 +64,12 @@ export declare const make: (value: bigint, scale: number) => BigDecimal;
  * @param self - The `BigDecimal` to normalize.
  *
  * @example
+ * ```ts
  * import { normalize, make, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(normalize(unsafeFromString("123.00000")), normalize(make(123n, 0)))
  * assert.deepStrictEqual(normalize(unsafeFromString("12300000")), normalize(make(123n, -5)))
+ * ```
  *
  * @since 2.0.0
  * @category scaling
@@ -120,9 +122,11 @@ export declare const scale: {
  * @param that - The second operand.
  *
  * @example
+ * ```ts
  * import { sum, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(sum(unsafeFromString("2"), unsafeFromString("3")), unsafeFromString("5"))
+ * ```
  *
  * @since 2.0.0
  * @category math
@@ -135,9 +139,11 @@ export declare const sum: {
      * @param that - The second operand.
      *
      * @example
+     * ```ts
      * import { sum, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(sum(unsafeFromString("2"), unsafeFromString("3")), unsafeFromString("5"))
+     * ```
      *
      * @since 2.0.0
      * @category math
@@ -150,9 +156,11 @@ export declare const sum: {
      * @param that - The second operand.
      *
      * @example
+     * ```ts
      * import { sum, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(sum(unsafeFromString("2"), unsafeFromString("3")), unsafeFromString("5"))
+     * ```
      *
      * @since 2.0.0
      * @category math
@@ -166,9 +174,11 @@ export declare const sum: {
  * @param that - The second operand.
  *
  * @example
+ * ```ts
  * import { multiply, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(multiply(unsafeFromString("2"), unsafeFromString("3")), unsafeFromString("6"))
+ * ```
  *
  * @since 2.0.0
  * @category math
@@ -181,9 +191,11 @@ export declare const multiply: {
      * @param that - The second operand.
      *
      * @example
+     * ```ts
      * import { multiply, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(multiply(unsafeFromString("2"), unsafeFromString("3")), unsafeFromString("6"))
+     * ```
      *
      * @since 2.0.0
      * @category math
@@ -196,9 +208,11 @@ export declare const multiply: {
      * @param that - The second operand.
      *
      * @example
+     * ```ts
      * import { multiply, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(multiply(unsafeFromString("2"), unsafeFromString("3")), unsafeFromString("6"))
+     * ```
      *
      * @since 2.0.0
      * @category math
@@ -212,9 +226,11 @@ export declare const multiply: {
  * @param that - The second operand.
  *
  * @example
+ * ```ts
  * import { subtract, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(subtract(unsafeFromString("2"), unsafeFromString("3")), unsafeFromString("-1"))
+ * ```
  *
  * @since 2.0.0
  * @category math
@@ -227,9 +243,11 @@ export declare const subtract: {
      * @param that - The second operand.
      *
      * @example
+     * ```ts
      * import { subtract, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(subtract(unsafeFromString("2"), unsafeFromString("3")), unsafeFromString("-1"))
+     * ```
      *
      * @since 2.0.0
      * @category math
@@ -242,9 +260,11 @@ export declare const subtract: {
      * @param that - The second operand.
      *
      * @example
+     * ```ts
      * import { subtract, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(subtract(unsafeFromString("2"), unsafeFromString("3")), unsafeFromString("-1"))
+     * ```
      *
      * @since 2.0.0
      * @category math
@@ -263,11 +283,13 @@ export declare const subtract: {
  * @param that - The divisor operand.
  *
  * @example
+ * ```ts
  * import { BigDecimal, Option } from "effect"
  *
  * assert.deepStrictEqual(BigDecimal.divide(BigDecimal.unsafeFromString("6"), BigDecimal.unsafeFromString("3")), Option.some(BigDecimal.unsafeFromString("2")))
  * assert.deepStrictEqual(BigDecimal.divide(BigDecimal.unsafeFromString("6"), BigDecimal.unsafeFromString("4")), Option.some(BigDecimal.unsafeFromString("1.5")))
  * assert.deepStrictEqual(BigDecimal.divide(BigDecimal.unsafeFromString("6"), BigDecimal.unsafeFromString("0")), Option.none())
+ * ```
  *
  * @since 2.0.0
  * @category math
@@ -285,11 +307,13 @@ export declare const divide: {
      * @param that - The divisor operand.
      *
      * @example
+     * ```ts
      * import { BigDecimal, Option } from "effect"
      *
      * assert.deepStrictEqual(BigDecimal.divide(BigDecimal.unsafeFromString("6"), BigDecimal.unsafeFromString("3")), Option.some(BigDecimal.unsafeFromString("2")))
      * assert.deepStrictEqual(BigDecimal.divide(BigDecimal.unsafeFromString("6"), BigDecimal.unsafeFromString("4")), Option.some(BigDecimal.unsafeFromString("1.5")))
      * assert.deepStrictEqual(BigDecimal.divide(BigDecimal.unsafeFromString("6"), BigDecimal.unsafeFromString("0")), Option.none())
+     * ```
      *
      * @since 2.0.0
      * @category math
@@ -307,11 +331,13 @@ export declare const divide: {
      * @param that - The divisor operand.
      *
      * @example
+     * ```ts
      * import { BigDecimal, Option } from "effect"
      *
      * assert.deepStrictEqual(BigDecimal.divide(BigDecimal.unsafeFromString("6"), BigDecimal.unsafeFromString("3")), Option.some(BigDecimal.unsafeFromString("2")))
      * assert.deepStrictEqual(BigDecimal.divide(BigDecimal.unsafeFromString("6"), BigDecimal.unsafeFromString("4")), Option.some(BigDecimal.unsafeFromString("1.5")))
      * assert.deepStrictEqual(BigDecimal.divide(BigDecimal.unsafeFromString("6"), BigDecimal.unsafeFromString("0")), Option.none())
+     * ```
      *
      * @since 2.0.0
      * @category math
@@ -330,10 +356,12 @@ export declare const divide: {
  * @param that - The divisor operand.as
  *
  * @example
+ * ```ts
  * import { unsafeDivide, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(unsafeDivide(unsafeFromString("6"), unsafeFromString("3")), unsafeFromString("2"))
  * assert.deepStrictEqual(unsafeDivide(unsafeFromString("6"), unsafeFromString("4")), unsafeFromString("1.5"))
+ * ```
  *
  * @since 2.0.0
  * @category math
@@ -351,10 +379,12 @@ export declare const unsafeDivide: {
      * @param that - The divisor operand.as
      *
      * @example
+     * ```ts
      * import { unsafeDivide, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(unsafeDivide(unsafeFromString("6"), unsafeFromString("3")), unsafeFromString("2"))
      * assert.deepStrictEqual(unsafeDivide(unsafeFromString("6"), unsafeFromString("4")), unsafeFromString("1.5"))
+     * ```
      *
      * @since 2.0.0
      * @category math
@@ -372,10 +402,12 @@ export declare const unsafeDivide: {
      * @param that - The divisor operand.as
      *
      * @example
+     * ```ts
      * import { unsafeDivide, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(unsafeDivide(unsafeFromString("6"), unsafeFromString("3")), unsafeFromString("2"))
      * assert.deepStrictEqual(unsafeDivide(unsafeFromString("6"), unsafeFromString("4")), unsafeFromString("1.5"))
+     * ```
      *
      * @since 2.0.0
      * @category math
@@ -394,11 +426,13 @@ export declare const Order: order.Order<BigDecimal>;
  * @param that - The second argument.
  *
  * @example
+ * ```ts
  * import { lessThan, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(lessThan(unsafeFromString("2"), unsafeFromString("3")), true)
  * assert.deepStrictEqual(lessThan(unsafeFromString("3"), unsafeFromString("3")), false)
  * assert.deepStrictEqual(lessThan(unsafeFromString("4"), unsafeFromString("3")), false)
+ * ```
  *
  * @since 2.0.0
  * @category predicates
@@ -411,11 +445,13 @@ export declare const lessThan: {
      * @param that - The second argument.
      *
      * @example
+     * ```ts
      * import { lessThan, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(lessThan(unsafeFromString("2"), unsafeFromString("3")), true)
      * assert.deepStrictEqual(lessThan(unsafeFromString("3"), unsafeFromString("3")), false)
      * assert.deepStrictEqual(lessThan(unsafeFromString("4"), unsafeFromString("3")), false)
+     * ```
      *
      * @since 2.0.0
      * @category predicates
@@ -428,11 +464,13 @@ export declare const lessThan: {
      * @param that - The second argument.
      *
      * @example
+     * ```ts
      * import { lessThan, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(lessThan(unsafeFromString("2"), unsafeFromString("3")), true)
      * assert.deepStrictEqual(lessThan(unsafeFromString("3"), unsafeFromString("3")), false)
      * assert.deepStrictEqual(lessThan(unsafeFromString("4"), unsafeFromString("3")), false)
+     * ```
      *
      * @since 2.0.0
      * @category predicates
@@ -446,11 +484,13 @@ export declare const lessThan: {
  * @param that - The second `BigDecimal` to compare with.
  *
  * @example
+ * ```ts
  * import { lessThanOrEqualTo, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(lessThanOrEqualTo(unsafeFromString("2"), unsafeFromString("3")), true)
  * assert.deepStrictEqual(lessThanOrEqualTo(unsafeFromString("3"), unsafeFromString("3")), true)
  * assert.deepStrictEqual(lessThanOrEqualTo(unsafeFromString("4"), unsafeFromString("3")), false)
+ * ```
  *
  * @since 2.0.0
  * @category predicates
@@ -463,11 +503,13 @@ export declare const lessThanOrEqualTo: {
      * @param that - The second `BigDecimal` to compare with.
      *
      * @example
+     * ```ts
      * import { lessThanOrEqualTo, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(lessThanOrEqualTo(unsafeFromString("2"), unsafeFromString("3")), true)
      * assert.deepStrictEqual(lessThanOrEqualTo(unsafeFromString("3"), unsafeFromString("3")), true)
      * assert.deepStrictEqual(lessThanOrEqualTo(unsafeFromString("4"), unsafeFromString("3")), false)
+     * ```
      *
      * @since 2.0.0
      * @category predicates
@@ -480,11 +522,13 @@ export declare const lessThanOrEqualTo: {
      * @param that - The second `BigDecimal` to compare with.
      *
      * @example
+     * ```ts
      * import { lessThanOrEqualTo, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(lessThanOrEqualTo(unsafeFromString("2"), unsafeFromString("3")), true)
      * assert.deepStrictEqual(lessThanOrEqualTo(unsafeFromString("3"), unsafeFromString("3")), true)
      * assert.deepStrictEqual(lessThanOrEqualTo(unsafeFromString("4"), unsafeFromString("3")), false)
+     * ```
      *
      * @since 2.0.0
      * @category predicates
@@ -498,11 +542,13 @@ export declare const lessThanOrEqualTo: {
  * @param that - The second argument.
  *
  * @example
+ * ```ts
  * import { greaterThan, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(greaterThan(unsafeFromString("2"), unsafeFromString("3")), false)
  * assert.deepStrictEqual(greaterThan(unsafeFromString("3"), unsafeFromString("3")), false)
  * assert.deepStrictEqual(greaterThan(unsafeFromString("4"), unsafeFromString("3")), true)
+ * ```
  *
  * @since 2.0.0
  * @category predicates
@@ -515,11 +561,13 @@ export declare const greaterThan: {
      * @param that - The second argument.
      *
      * @example
+     * ```ts
      * import { greaterThan, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(greaterThan(unsafeFromString("2"), unsafeFromString("3")), false)
      * assert.deepStrictEqual(greaterThan(unsafeFromString("3"), unsafeFromString("3")), false)
      * assert.deepStrictEqual(greaterThan(unsafeFromString("4"), unsafeFromString("3")), true)
+     * ```
      *
      * @since 2.0.0
      * @category predicates
@@ -532,11 +580,13 @@ export declare const greaterThan: {
      * @param that - The second argument.
      *
      * @example
+     * ```ts
      * import { greaterThan, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(greaterThan(unsafeFromString("2"), unsafeFromString("3")), false)
      * assert.deepStrictEqual(greaterThan(unsafeFromString("3"), unsafeFromString("3")), false)
      * assert.deepStrictEqual(greaterThan(unsafeFromString("4"), unsafeFromString("3")), true)
+     * ```
      *
      * @since 2.0.0
      * @category predicates
@@ -550,11 +600,13 @@ export declare const greaterThan: {
  * @param that - The second `BigDecimal` to compare with.
  *
  * @example
+ * ```ts
  * import { greaterThanOrEqualTo, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(greaterThanOrEqualTo(unsafeFromString("2"), unsafeFromString("3")), false)
  * assert.deepStrictEqual(greaterThanOrEqualTo(unsafeFromString("3"), unsafeFromString("3")), true)
  * assert.deepStrictEqual(greaterThanOrEqualTo(unsafeFromString("4"), unsafeFromString("3")), true)
+ * ```
  *
  * @since 2.0.0
  * @category predicates
@@ -567,11 +619,13 @@ export declare const greaterThanOrEqualTo: {
      * @param that - The second `BigDecimal` to compare with.
      *
      * @example
+     * ```ts
      * import { greaterThanOrEqualTo, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(greaterThanOrEqualTo(unsafeFromString("2"), unsafeFromString("3")), false)
      * assert.deepStrictEqual(greaterThanOrEqualTo(unsafeFromString("3"), unsafeFromString("3")), true)
      * assert.deepStrictEqual(greaterThanOrEqualTo(unsafeFromString("4"), unsafeFromString("3")), true)
+     * ```
      *
      * @since 2.0.0
      * @category predicates
@@ -584,11 +638,13 @@ export declare const greaterThanOrEqualTo: {
      * @param that - The second `BigDecimal` to compare with.
      *
      * @example
+     * ```ts
      * import { greaterThanOrEqualTo, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(greaterThanOrEqualTo(unsafeFromString("2"), unsafeFromString("3")), false)
      * assert.deepStrictEqual(greaterThanOrEqualTo(unsafeFromString("3"), unsafeFromString("3")), true)
      * assert.deepStrictEqual(greaterThanOrEqualTo(unsafeFromString("4"), unsafeFromString("3")), true)
+     * ```
      *
      * @since 2.0.0
      * @category predicates
@@ -603,6 +659,7 @@ export declare const greaterThanOrEqualTo: {
  * @param maximum - The `maximum` value to check.
  *
  * @example
+ * ```ts
  * import { BigDecimal } from "effect"
  *
  * const between = BigDecimal.between({
@@ -613,6 +670,7 @@ export declare const greaterThanOrEqualTo: {
  * assert.deepStrictEqual(between(BigDecimal.unsafeFromString("3")), true)
  * assert.deepStrictEqual(between(BigDecimal.unsafeFromString("0")), false)
  * assert.deepStrictEqual(between(BigDecimal.unsafeFromString("6")), false)
+ * ```
  *
  * @since 2.0.0
  * @category predicates
@@ -626,6 +684,7 @@ export declare const between: {
      * @param maximum - The `maximum` value to check.
      *
      * @example
+     * ```ts
      * import { BigDecimal } from "effect"
      *
      * const between = BigDecimal.between({
@@ -636,6 +695,7 @@ export declare const between: {
      * assert.deepStrictEqual(between(BigDecimal.unsafeFromString("3")), true)
      * assert.deepStrictEqual(between(BigDecimal.unsafeFromString("0")), false)
      * assert.deepStrictEqual(between(BigDecimal.unsafeFromString("6")), false)
+     * ```
      *
      * @since 2.0.0
      * @category predicates
@@ -652,6 +712,7 @@ export declare const between: {
      * @param maximum - The `maximum` value to check.
      *
      * @example
+     * ```ts
      * import { BigDecimal } from "effect"
      *
      * const between = BigDecimal.between({
@@ -662,6 +723,7 @@ export declare const between: {
      * assert.deepStrictEqual(between(BigDecimal.unsafeFromString("3")), true)
      * assert.deepStrictEqual(between(BigDecimal.unsafeFromString("0")), false)
      * assert.deepStrictEqual(between(BigDecimal.unsafeFromString("6")), false)
+     * ```
      *
      * @since 2.0.0
      * @category predicates
@@ -683,6 +745,7 @@ export declare const between: {
  * @param maximum - The upper end of the range.
  *
  * @example
+ * ```ts
  * import { BigDecimal } from "effect"
  *
  * const clamp = BigDecimal.clamp({
@@ -693,6 +756,7 @@ export declare const between: {
  * assert.deepStrictEqual(clamp(BigDecimal.unsafeFromString("3")), BigDecimal.unsafeFromString("3"))
  * assert.deepStrictEqual(clamp(BigDecimal.unsafeFromString("0")), BigDecimal.unsafeFromString("1"))
  * assert.deepStrictEqual(clamp(BigDecimal.unsafeFromString("6")), BigDecimal.unsafeFromString("5"))
+ * ```
  *
  * @since 2.0.0
  * @category math
@@ -710,6 +774,7 @@ export declare const clamp: {
      * @param maximum - The upper end of the range.
      *
      * @example
+     * ```ts
      * import { BigDecimal } from "effect"
      *
      * const clamp = BigDecimal.clamp({
@@ -720,6 +785,7 @@ export declare const clamp: {
      * assert.deepStrictEqual(clamp(BigDecimal.unsafeFromString("3")), BigDecimal.unsafeFromString("3"))
      * assert.deepStrictEqual(clamp(BigDecimal.unsafeFromString("0")), BigDecimal.unsafeFromString("1"))
      * assert.deepStrictEqual(clamp(BigDecimal.unsafeFromString("6")), BigDecimal.unsafeFromString("5"))
+     * ```
      *
      * @since 2.0.0
      * @category math
@@ -740,6 +806,7 @@ export declare const clamp: {
      * @param maximum - The upper end of the range.
      *
      * @example
+     * ```ts
      * import { BigDecimal } from "effect"
      *
      * const clamp = BigDecimal.clamp({
@@ -750,6 +817,7 @@ export declare const clamp: {
      * assert.deepStrictEqual(clamp(BigDecimal.unsafeFromString("3")), BigDecimal.unsafeFromString("3"))
      * assert.deepStrictEqual(clamp(BigDecimal.unsafeFromString("0")), BigDecimal.unsafeFromString("1"))
      * assert.deepStrictEqual(clamp(BigDecimal.unsafeFromString("6")), BigDecimal.unsafeFromString("5"))
+     * ```
      *
      * @since 2.0.0
      * @category math
@@ -766,9 +834,11 @@ export declare const clamp: {
  * @param that - The second `BigDecimal`.
  *
  * @example
+ * ```ts
  * import { min, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(min(unsafeFromString("2"), unsafeFromString("3")), unsafeFromString("2"))
+ * ```
  *
  * @since 2.0.0
  * @category math
@@ -781,9 +851,11 @@ export declare const min: {
      * @param that - The second `BigDecimal`.
      *
      * @example
+     * ```ts
      * import { min, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(min(unsafeFromString("2"), unsafeFromString("3")), unsafeFromString("2"))
+     * ```
      *
      * @since 2.0.0
      * @category math
@@ -796,9 +868,11 @@ export declare const min: {
      * @param that - The second `BigDecimal`.
      *
      * @example
+     * ```ts
      * import { min, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(min(unsafeFromString("2"), unsafeFromString("3")), unsafeFromString("2"))
+     * ```
      *
      * @since 2.0.0
      * @category math
@@ -812,9 +886,11 @@ export declare const min: {
  * @param that - The second `BigDecimal`.
  *
  * @example
+ * ```ts
  * import { max, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(max(unsafeFromString("2"), unsafeFromString("3")), unsafeFromString("3"))
+ * ```
  *
  * @since 2.0.0
  * @category math
@@ -827,9 +903,11 @@ export declare const max: {
      * @param that - The second `BigDecimal`.
      *
      * @example
+     * ```ts
      * import { max, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(max(unsafeFromString("2"), unsafeFromString("3")), unsafeFromString("3"))
+     * ```
      *
      * @since 2.0.0
      * @category math
@@ -842,9 +920,11 @@ export declare const max: {
      * @param that - The second `BigDecimal`.
      *
      * @example
+     * ```ts
      * import { max, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(max(unsafeFromString("2"), unsafeFromString("3")), unsafeFromString("3"))
+     * ```
      *
      * @since 2.0.0
      * @category math
@@ -857,11 +937,13 @@ export declare const max: {
  * @param n - The `BigDecimal` to determine the sign of.
  *
  * @example
+ * ```ts
  * import { sign, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(sign(unsafeFromString("-5")), -1)
  * assert.deepStrictEqual(sign(unsafeFromString("0")), 0)
  * assert.deepStrictEqual(sign(unsafeFromString("5")), 1)
+ * ```
  *
  * @since 2.0.0
  * @category math
@@ -873,11 +955,13 @@ export declare const sign: (n: BigDecimal) => Ordering;
  * @param n - The `BigDecimal` to determine the absolute value of.
  *
  * @example
+ * ```ts
  * import { abs, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(abs(unsafeFromString("-5")), unsafeFromString("5"))
  * assert.deepStrictEqual(abs(unsafeFromString("0")), unsafeFromString("0"))
  * assert.deepStrictEqual(abs(unsafeFromString("5")), unsafeFromString("5"))
+ * ```
  *
  * @since 2.0.0
  * @category math
@@ -889,10 +973,12 @@ export declare const abs: (n: BigDecimal) => BigDecimal;
  * @param n - The `BigDecimal` to negate.
  *
  * @example
+ * ```ts
  * import { negate, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(negate(unsafeFromString("3")), unsafeFromString("-3"))
  * assert.deepStrictEqual(negate(unsafeFromString("-6")), unsafeFromString("6"))
+ * ```
  *
  * @since 2.0.0
  * @category math
@@ -907,11 +993,13 @@ export declare const negate: (n: BigDecimal) => BigDecimal;
  * @param divisor - The divisor.
  *
  * @example
+ * ```ts
  * import { BigDecimal, Option } from "effect"
  *
  * assert.deepStrictEqual(BigDecimal.remainder(BigDecimal.unsafeFromString("2"), BigDecimal.unsafeFromString("2")), Option.some(BigDecimal.unsafeFromString("0")))
  * assert.deepStrictEqual(BigDecimal.remainder(BigDecimal.unsafeFromString("3"), BigDecimal.unsafeFromString("2")), Option.some(BigDecimal.unsafeFromString("1")))
  * assert.deepStrictEqual(BigDecimal.remainder(BigDecimal.unsafeFromString("-4"), BigDecimal.unsafeFromString("2")), Option.some(BigDecimal.unsafeFromString("0")))
+ * ```
  *
  * @since 2.0.0
  * @category math
@@ -926,11 +1014,13 @@ export declare const remainder: {
      * @param divisor - The divisor.
      *
      * @example
+     * ```ts
      * import { BigDecimal, Option } from "effect"
      *
      * assert.deepStrictEqual(BigDecimal.remainder(BigDecimal.unsafeFromString("2"), BigDecimal.unsafeFromString("2")), Option.some(BigDecimal.unsafeFromString("0")))
      * assert.deepStrictEqual(BigDecimal.remainder(BigDecimal.unsafeFromString("3"), BigDecimal.unsafeFromString("2")), Option.some(BigDecimal.unsafeFromString("1")))
      * assert.deepStrictEqual(BigDecimal.remainder(BigDecimal.unsafeFromString("-4"), BigDecimal.unsafeFromString("2")), Option.some(BigDecimal.unsafeFromString("0")))
+     * ```
      *
      * @since 2.0.0
      * @category math
@@ -945,11 +1035,13 @@ export declare const remainder: {
      * @param divisor - The divisor.
      *
      * @example
+     * ```ts
      * import { BigDecimal, Option } from "effect"
      *
      * assert.deepStrictEqual(BigDecimal.remainder(BigDecimal.unsafeFromString("2"), BigDecimal.unsafeFromString("2")), Option.some(BigDecimal.unsafeFromString("0")))
      * assert.deepStrictEqual(BigDecimal.remainder(BigDecimal.unsafeFromString("3"), BigDecimal.unsafeFromString("2")), Option.some(BigDecimal.unsafeFromString("1")))
      * assert.deepStrictEqual(BigDecimal.remainder(BigDecimal.unsafeFromString("-4"), BigDecimal.unsafeFromString("2")), Option.some(BigDecimal.unsafeFromString("0")))
+     * ```
      *
      * @since 2.0.0
      * @category math
@@ -965,11 +1057,13 @@ export declare const remainder: {
  * @param divisor - The divisor.
  *
  * @example
+ * ```ts
  * import { unsafeRemainder, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(unsafeRemainder(unsafeFromString("2"), unsafeFromString("2")), unsafeFromString("0"))
  * assert.deepStrictEqual(unsafeRemainder(unsafeFromString("3"), unsafeFromString("2")), unsafeFromString("1"))
  * assert.deepStrictEqual(unsafeRemainder(unsafeFromString("-4"), unsafeFromString("2")), unsafeFromString("0"))
+ * ```
  *
  * @since 2.0.0
  * @category math
@@ -984,11 +1078,13 @@ export declare const unsafeRemainder: {
      * @param divisor - The divisor.
      *
      * @example
+     * ```ts
      * import { unsafeRemainder, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(unsafeRemainder(unsafeFromString("2"), unsafeFromString("2")), unsafeFromString("0"))
      * assert.deepStrictEqual(unsafeRemainder(unsafeFromString("3"), unsafeFromString("2")), unsafeFromString("1"))
      * assert.deepStrictEqual(unsafeRemainder(unsafeFromString("-4"), unsafeFromString("2")), unsafeFromString("0"))
+     * ```
      *
      * @since 2.0.0
      * @category math
@@ -1003,11 +1099,13 @@ export declare const unsafeRemainder: {
      * @param divisor - The divisor.
      *
      * @example
+     * ```ts
      * import { unsafeRemainder, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(unsafeRemainder(unsafeFromString("2"), unsafeFromString("2")), unsafeFromString("0"))
      * assert.deepStrictEqual(unsafeRemainder(unsafeFromString("3"), unsafeFromString("2")), unsafeFromString("1"))
      * assert.deepStrictEqual(unsafeRemainder(unsafeFromString("-4"), unsafeFromString("2")), unsafeFromString("0"))
+     * ```
      *
      * @since 2.0.0
      * @category math
@@ -1056,29 +1154,71 @@ export declare const fromBigInt: (n: bigint) => BigDecimal;
  * It is not recommended to convert a floating point number to a decimal directly,
  * as the floating point representation may be unexpected.
  *
+ * Throws a `RangeError` if the number is not finite (`NaN`, `+Infinity` or `-Infinity`).
+ *
  * @param value - The `number` value to create a `BigDecimal` from.
  *
  * @example
+ * ```ts
  * import { fromNumber, make } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(fromNumber(123), make(123n, 0))
  * assert.deepStrictEqual(fromNumber(123.456), make(123456n, 3))
+ * ```
+ *
+ * @since 3.11.0
+ * @category constructors
+ */
+export declare const unsafeFromNumber: (n: number) => BigDecimal;
+/**
+ * Creates a `BigDecimal` from a `number` value.
+ *
+ * It is not recommended to convert a floating point number to a decimal directly,
+ * as the floating point representation may be unexpected.
+ *
+ * Throws a `RangeError` if the number is not finite (`NaN`, `+Infinity` or `-Infinity`).
+ *
+ * @param value - The `number` value to create a `BigDecimal` from.
  *
  * @since 2.0.0
  * @category constructors
+ * @deprecated Use {@link unsafeFromNumber} instead.
  */
 export declare const fromNumber: (n: number) => BigDecimal;
+/**
+ * Creates a `BigDecimal` from a `number` value.
+ *
+ * It is not recommended to convert a floating point number to a decimal directly,
+ * as the floating point representation may be unexpected.
+ *
+ * Returns `None` if the number is not finite (`NaN`, `+Infinity` or `-Infinity`).
+ *
+ * @param n - The `number` value to create a `BigDecimal` from.
+ *
+ * @example
+ * import { BigDecimal, Option } from "effect"
+ *
+ * assert.deepStrictEqual(BigDecimal.safeFromNumber(123), Option.some(BigDecimal.make(123n, 0)))
+ * assert.deepStrictEqual(BigDecimal.safeFromNumber(123.456), Option.some(BigDecimal.make(123456n, 3)))
+ * assert.deepStrictEqual(BigDecimal.safeFromNumber(Infinity), Option.none())
+ *
+ * @since 3.11.0
+ * @category constructors
+ */
+export declare const safeFromNumber: (n: number) => Option.Option<BigDecimal>;
 /**
  * Parses a numerical `string` into a `BigDecimal`.
  *
  * @param s - The `string` to parse.
  *
  * @example
+ * ```ts
  * import { BigDecimal, Option } from "effect"
  *
  * assert.deepStrictEqual(BigDecimal.fromString("123"), Option.some(BigDecimal.make(123n, 0)))
  * assert.deepStrictEqual(BigDecimal.fromString("123.456"), Option.some(BigDecimal.make(123456n, 3)))
  * assert.deepStrictEqual(BigDecimal.fromString("123.abc"), Option.none())
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -1090,11 +1230,13 @@ export declare const fromString: (s: string) => Option.Option<BigDecimal>;
  * @param s - The `string` to parse.
  *
  * @example
+ * ```ts
  * import { unsafeFromString, make } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(unsafeFromString("123"), make(123n, 0))
  * assert.deepStrictEqual(unsafeFromString("123.456"), make(123456n, 3))
  * assert.throws(() => unsafeFromString("123.abc"))
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -1103,19 +1245,38 @@ export declare const unsafeFromString: (s: string) => BigDecimal;
 /**
  * Formats a given `BigDecimal` as a `string`.
  *
- * @param normalized - The `BigDecimal` to format.
+ * If the scale of the `BigDecimal` is greater than or equal to 16, the `BigDecimal` will
+ * be formatted in scientific notation.
+ *
+ * @param n - The `BigDecimal` to format.
  *
  * @example
+ * ```ts
  * import { format, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(format(unsafeFromString("-5")), "-5")
  * assert.deepStrictEqual(format(unsafeFromString("123.456")), "123.456")
  * assert.deepStrictEqual(format(unsafeFromString("-0.00000123")), "-0.00000123")
+ * ```
  *
  * @since 2.0.0
  * @category conversions
  */
 export declare const format: (n: BigDecimal) => string;
+/**
+ * Formats a given `BigDecimal` as a `string` in scientific notation.
+ *
+ * @param n - The `BigDecimal` to format.
+ *
+ * @example
+ * import { toExponential, make } from "effect/BigDecimal"
+ *
+ * assert.deepStrictEqual(toExponential(make(123456n, -5)), "1.23456e+10")
+ *
+ * @since 3.11.0
+ * @category conversions
+ */
+export declare const toExponential: (n: BigDecimal) => string;
 /**
  * Converts a `BigDecimal` to a `number`.
  *
@@ -1124,9 +1285,11 @@ export declare const format: (n: BigDecimal) => string;
  * @param n - The `BigDecimal` to convert.
  *
  * @example
+ * ```ts
  * import { unsafeToNumber, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(unsafeToNumber(unsafeFromString("123.456")), 123.456)
+ * ```
  *
  * @since 2.0.0
  * @category conversions
@@ -1138,11 +1301,13 @@ export declare const unsafeToNumber: (n: BigDecimal) => number;
  * @param n - The `BigDecimal` to check.
  *
  * @example
+ * ```ts
  * import { isInteger, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(isInteger(unsafeFromString("0")), true)
  * assert.deepStrictEqual(isInteger(unsafeFromString("1")), true)
  * assert.deepStrictEqual(isInteger(unsafeFromString("1.1")), false)
+ * ```
  *
  * @since 2.0.0
  * @category predicates
@@ -1154,10 +1319,12 @@ export declare const isInteger: (n: BigDecimal) => boolean;
  * @param n - The `BigDecimal` to check.
  *
  * @example
+ * ```ts
  * import { isZero, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(isZero(unsafeFromString("0")), true)
  * assert.deepStrictEqual(isZero(unsafeFromString("1")), false)
+ * ```
  *
  * @since 2.0.0
  * @category predicates
@@ -1169,11 +1336,13 @@ export declare const isZero: (n: BigDecimal) => boolean;
  * @param n - The `BigDecimal` to check.
  *
  * @example
+ * ```ts
  * import { isNegative, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(isNegative(unsafeFromString("-1")), true)
  * assert.deepStrictEqual(isNegative(unsafeFromString("0")), false)
  * assert.deepStrictEqual(isNegative(unsafeFromString("1")), false)
+ * ```
  *
  * @since 2.0.0
  * @category predicates
@@ -1185,11 +1354,13 @@ export declare const isNegative: (n: BigDecimal) => boolean;
  * @param n - The `BigDecimal` to check.
  *
  * @example
+ * ```ts
  * import { isPositive, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(isPositive(unsafeFromString("-1")), false)
  * assert.deepStrictEqual(isPositive(unsafeFromString("0")), false)
  * assert.deepStrictEqual(isPositive(unsafeFromString("1")), true)
+ * ```
  *
  * @since 2.0.0
  * @category predicates