effect 3.10.18 → 3.10.19

package/src/BigDecimal.ts

@@ -134,10 +134,12 @@ const zero = unsafeMakeNormalized(bigint0, 0)
  * @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
@@ -229,9 +231,11 @@ export 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
@@ -244,9 +248,11 @@ export 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
@@ -259,9 +265,11 @@ export 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
@@ -294,9 +302,11 @@ export 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
@@ -309,9 +319,11 @@ export 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
@@ -324,9 +336,11 @@ export 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
@@ -347,9 +361,11 @@ export 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
@@ -362,9 +378,11 @@ export 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
@@ -377,9 +395,11 @@ export 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
@@ -485,11 +505,13 @@ export const roundTerminal = (n: bigint): bigint => {
  * @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
@@ -507,11 +529,13 @@ export 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
@@ -529,11 +553,13 @@ export 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
@@ -568,10 +594,12 @@ export 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
@@ -589,10 +617,12 @@ export 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
@@ -610,10 +640,12 @@ export 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
@@ -663,11 +695,13 @@ export const Order: order.Order<BigDecimal> = order.make((self, that) => {
  * @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
@@ -680,11 +714,13 @@ export 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
@@ -697,11 +733,13 @@ export 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
@@ -716,11 +754,13 @@ export 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
@@ -733,11 +773,13 @@ export 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
@@ -750,11 +792,13 @@ export 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
@@ -769,11 +813,13 @@ export 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
@@ -786,11 +832,13 @@ export 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
@@ -803,11 +851,13 @@ export 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
@@ -822,11 +872,13 @@ export 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
@@ -839,11 +891,13 @@ export 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
@@ -856,11 +910,13 @@ export 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
@@ -876,6 +932,7 @@ export const greaterThanOrEqualTo: {
  * @param maximum - The `maximum` value to check.
  *
  * @example
+ * ```ts
  * import { BigDecimal } from "effect"
  *
  * const between = BigDecimal.between({
@@ -886,6 +943,7 @@ export 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
@@ -899,6 +957,7 @@ export const between: {
    * @param maximum - The `maximum` value to check.
    *
    * @example
+   * ```ts
    * import { BigDecimal } from "effect"
    *
    * const between = BigDecimal.between({
@@ -909,6 +968,7 @@ export 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
@@ -927,6 +987,7 @@ export const between: {
    * @param maximum - The `maximum` value to check.
    *
    * @example
+   * ```ts
    * import { BigDecimal } from "effect"
    *
    * const between = BigDecimal.between({
@@ -937,6 +998,7 @@ export 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
@@ -962,6 +1024,7 @@ export const between: {
  * @param maximum - The upper end of the range.
  *
  * @example
+ * ```ts
  * import { BigDecimal } from "effect"
  *
  * const clamp = BigDecimal.clamp({
@@ -972,6 +1035,7 @@ export 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
@@ -989,6 +1053,7 @@ export const clamp: {
    * @param maximum - The upper end of the range.
    *
    * @example
+   * ```ts
    * import { BigDecimal } from "effect"
    *
    * const clamp = BigDecimal.clamp({
@@ -999,6 +1064,7 @@ export 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
@@ -1021,6 +1087,7 @@ export const clamp: {
    * @param maximum - The upper end of the range.
    *
    * @example
+   * ```ts
    * import { BigDecimal } from "effect"
    *
    * const clamp = BigDecimal.clamp({
@@ -1031,6 +1098,7 @@ export 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
@@ -1051,9 +1119,11 @@ export 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
@@ -1066,9 +1136,11 @@ export 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
@@ -1081,9 +1153,11 @@ export 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
@@ -1098,9 +1172,11 @@ export 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
@@ -1113,9 +1189,11 @@ export 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
@@ -1128,9 +1206,11 @@ export 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
@@ -1144,11 +1224,13 @@ export 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
@@ -1161,11 +1243,13 @@ export const sign = (n: BigDecimal): Ordering => n.value === bigint0 ? 0 : n.val
  * @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
@@ -1178,10 +1262,12 @@ export const abs = (n: BigDecimal): BigDecimal => n.value < bigint0 ? make(-n.va
  * @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
@@ -1197,11 +1283,13 @@ export const negate = (n: BigDecimal): BigDecimal => make(-n.value, n.scale)
  * @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
@@ -1216,11 +1304,13 @@ export 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
@@ -1235,11 +1325,13 @@ export 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
@@ -1263,11 +1355,13 @@ export 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
@@ -1282,11 +1376,13 @@ export 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
@@ -1301,11 +1397,13 @@ export 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
@@ -1378,10 +1476,12 @@ export const fromBigInt = (n: bigint): BigDecimal => make(n, 0)
  * @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 2.0.0
  * @category constructors
@@ -1397,11 +1497,13 @@ export const fromNumber = (n: number): 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
@@ -1439,11 +1541,13 @@ export 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
@@ -1457,11 +1561,13 @@ export const unsafeFromString = (s: string): BigDecimal =>
  * @param normalized - 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
@@ -1500,9 +1606,11 @@ export 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
@@ -1515,11 +1623,13 @@ export const unsafeToNumber = (n: BigDecimal): number => Number(format(n))
  * @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
@@ -1532,10 +1642,12 @@ export const isInteger = (n: BigDecimal): boolean => normalize(n).scale <= 0
  * @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
@@ -1548,11 +1660,13 @@ export const isZero = (n: BigDecimal): boolean => n.value === bigint0
  * @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
@@ -1565,11 +1679,13 @@ export const isNegative = (n: BigDecimal): boolean => n.value < bigint0
  * @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