effect 3.13.8 → 3.13.9

package/dist/dts/BigDecimal.d.ts

@@ -42,8 +42,6 @@ export interface BigDecimal extends Equal.Equal, Pipeable, Inspectable {
 /**
  * Checks if a given value is a `BigDecimal`.
  *
- * @param u - The value to check.
- *
  * @since 2.0.0
  * @category guards
  */
@@ -51,9 +49,6 @@ export declare const isBigDecimal: (u: unknown) => u is BigDecimal;
 /**
  * Creates a `BigDecimal` from a `bigint` value and a scale.
  *
- * @param value - The `bigint` value to create a `BigDecimal` from.
- * @param scale - The scale of the `BigDecimal`.
- *
  * @since 2.0.0
  * @category constructors
  */
@@ -61,10 +56,10 @@ export declare const make: (value: bigint, scale: number) => BigDecimal;
 /**
  * Normalizes a given `BigDecimal` by removing trailing zeros.
  *
- * @param self - The `BigDecimal` to normalize.
+ * **Example**
  *
- * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { normalize, make, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(normalize(unsafeFromString("123.00000")), normalize(make(123n, 0)))
@@ -81,9 +76,6 @@ export declare const normalize: (self: BigDecimal) => BigDecimal;
  * If the given scale is smaller than the current scale, the value will be rounded down to
  * the nearest integer.
  *
- * @param self - The `BigDecimal` to scale.
- * @param scale - The scale to scale to.
- *
  * @since 2.0.0
  * @category scaling
  */
@@ -94,9 +86,6 @@ export declare const scale: {
      * If the given scale is smaller than the current scale, the value will be rounded down to
      * the nearest integer.
      *
-     * @param self - The `BigDecimal` to scale.
-     * @param scale - The scale to scale to.
-     *
      * @since 2.0.0
      * @category scaling
      */
@@ -107,9 +96,6 @@ export declare const scale: {
      * If the given scale is smaller than the current scale, the value will be rounded down to
      * the nearest integer.
      *
-     * @param self - The `BigDecimal` to scale.
-     * @param scale - The scale to scale to.
-     *
      * @since 2.0.0
      * @category scaling
      */
@@ -118,11 +104,9 @@ export declare const scale: {
 /**
  * Provides an addition operation on `BigDecimal`s.
  *
- * @param self - The first operand.
- * @param that - The second operand.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { sum, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(sum(unsafeFromString("2"), unsafeFromString("3")), unsafeFromString("5"))
@@ -135,11 +119,9 @@ export declare const sum: {
     /**
      * Provides an addition operation on `BigDecimal`s.
      *
-     * @param self - The first operand.
-     * @param that - The second operand.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { sum, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(sum(unsafeFromString("2"), unsafeFromString("3")), unsafeFromString("5"))
@@ -152,11 +134,9 @@ export declare const sum: {
     /**
      * Provides an addition operation on `BigDecimal`s.
      *
-     * @param self - The first operand.
-     * @param that - The second operand.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { sum, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(sum(unsafeFromString("2"), unsafeFromString("3")), unsafeFromString("5"))
@@ -170,11 +150,9 @@ export declare const sum: {
 /**
  * Provides a multiplication operation on `BigDecimal`s.
  *
- * @param self - The first operand.
- * @param that - The second operand.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { multiply, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(multiply(unsafeFromString("2"), unsafeFromString("3")), unsafeFromString("6"))
@@ -187,11 +165,9 @@ export declare const multiply: {
     /**
      * Provides a multiplication operation on `BigDecimal`s.
      *
-     * @param self - The first operand.
-     * @param that - The second operand.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { multiply, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(multiply(unsafeFromString("2"), unsafeFromString("3")), unsafeFromString("6"))
@@ -204,11 +180,9 @@ export declare const multiply: {
     /**
      * Provides a multiplication operation on `BigDecimal`s.
      *
-     * @param self - The first operand.
-     * @param that - The second operand.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { multiply, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(multiply(unsafeFromString("2"), unsafeFromString("3")), unsafeFromString("6"))
@@ -222,11 +196,9 @@ export declare const multiply: {
 /**
  * Provides a subtraction operation on `BigDecimal`s.
  *
- * @param self - The first operand.
- * @param that - The second operand.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { subtract, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(subtract(unsafeFromString("2"), unsafeFromString("3")), unsafeFromString("-1"))
@@ -239,11 +211,9 @@ export declare const subtract: {
     /**
      * Provides a subtraction operation on `BigDecimal`s.
      *
-     * @param self - The first operand.
-     * @param that - The second operand.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { subtract, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(subtract(unsafeFromString("2"), unsafeFromString("3")), unsafeFromString("-1"))
@@ -256,11 +226,9 @@ export declare const subtract: {
     /**
      * Provides a subtraction operation on `BigDecimal`s.
      *
-     * @param self - The first operand.
-     * @param that - The second operand.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { subtract, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(subtract(unsafeFromString("2"), unsafeFromString("3")), unsafeFromString("-1"))
@@ -279,11 +247,9 @@ export declare const subtract: {
  *
  * If the divisor is `0`, the result will be `None`.
  *
- * @param self - The dividend operand.
- * @param that - The divisor operand.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { BigDecimal, Option } from "effect"
  *
  * assert.deepStrictEqual(BigDecimal.divide(BigDecimal.unsafeFromString("6"), BigDecimal.unsafeFromString("3")), Option.some(BigDecimal.unsafeFromString("2")))
@@ -303,11 +269,9 @@ export declare const divide: {
      *
      * If the divisor is `0`, the result will be `None`.
      *
-     * @param self - The dividend operand.
-     * @param that - The divisor operand.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { BigDecimal, Option } from "effect"
      *
      * assert.deepStrictEqual(BigDecimal.divide(BigDecimal.unsafeFromString("6"), BigDecimal.unsafeFromString("3")), Option.some(BigDecimal.unsafeFromString("2")))
@@ -327,11 +291,9 @@ export declare const divide: {
      *
      * If the divisor is `0`, the result will be `None`.
      *
-     * @param self - The dividend operand.
-     * @param that - The divisor operand.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { BigDecimal, Option } from "effect"
      *
      * assert.deepStrictEqual(BigDecimal.divide(BigDecimal.unsafeFromString("6"), BigDecimal.unsafeFromString("3")), Option.some(BigDecimal.unsafeFromString("2")))
@@ -352,11 +314,9 @@ export declare const divide: {
  *
  * Throws a `RangeError` if the divisor is `0`.
  *
- * @param self - The dividend operand.
- * @param that - The divisor operand.as
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { unsafeDivide, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(unsafeDivide(unsafeFromString("6"), unsafeFromString("3")), unsafeFromString("2"))
@@ -375,11 +335,9 @@ export declare const unsafeDivide: {
      *
      * Throws a `RangeError` if the divisor is `0`.
      *
-     * @param self - The dividend operand.
-     * @param that - The divisor operand.as
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { unsafeDivide, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(unsafeDivide(unsafeFromString("6"), unsafeFromString("3")), unsafeFromString("2"))
@@ -398,11 +356,9 @@ export declare const unsafeDivide: {
      *
      * Throws a `RangeError` if the divisor is `0`.
      *
-     * @param self - The dividend operand.
-     * @param that - The divisor operand.as
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { unsafeDivide, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(unsafeDivide(unsafeFromString("6"), unsafeFromString("3")), unsafeFromString("2"))
@@ -422,11 +378,9 @@ export declare const Order: order.Order<BigDecimal>;
 /**
  * Returns `true` if the first argument is less than the second, otherwise `false`.
  *
- * @param self - The first argument.
- * @param that - The second argument.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { lessThan, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(lessThan(unsafeFromString("2"), unsafeFromString("3")), true)
@@ -441,11 +395,9 @@ export declare const lessThan: {
     /**
      * Returns `true` if the first argument is less than the second, otherwise `false`.
      *
-     * @param self - The first argument.
-     * @param that - The second argument.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { lessThan, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(lessThan(unsafeFromString("2"), unsafeFromString("3")), true)
@@ -460,11 +412,9 @@ export declare const lessThan: {
     /**
      * Returns `true` if the first argument is less than the second, otherwise `false`.
      *
-     * @param self - The first argument.
-     * @param that - The second argument.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { lessThan, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(lessThan(unsafeFromString("2"), unsafeFromString("3")), true)
@@ -480,11 +430,9 @@ export declare const lessThan: {
 /**
  * Checks if a given `BigDecimal` is less than or equal to the provided one.
  *
- * @param self - The first `BigDecimal` to compare with.
- * @param that - The second `BigDecimal` to compare with.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { lessThanOrEqualTo, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(lessThanOrEqualTo(unsafeFromString("2"), unsafeFromString("3")), true)
@@ -499,11 +447,9 @@ export declare const lessThanOrEqualTo: {
     /**
      * Checks if a given `BigDecimal` is less than or equal to the provided one.
      *
-     * @param self - The first `BigDecimal` to compare with.
-     * @param that - The second `BigDecimal` to compare with.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { lessThanOrEqualTo, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(lessThanOrEqualTo(unsafeFromString("2"), unsafeFromString("3")), true)
@@ -518,11 +464,9 @@ export declare const lessThanOrEqualTo: {
     /**
      * Checks if a given `BigDecimal` is less than or equal to the provided one.
      *
-     * @param self - The first `BigDecimal` to compare with.
-     * @param that - The second `BigDecimal` to compare with.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { lessThanOrEqualTo, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(lessThanOrEqualTo(unsafeFromString("2"), unsafeFromString("3")), true)
@@ -538,11 +482,9 @@ export declare const lessThanOrEqualTo: {
 /**
  * Returns `true` if the first argument is greater than the second, otherwise `false`.
  *
- * @param self - The first argument.
- * @param that - The second argument.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { greaterThan, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(greaterThan(unsafeFromString("2"), unsafeFromString("3")), false)
@@ -557,11 +499,9 @@ export declare const greaterThan: {
     /**
      * Returns `true` if the first argument is greater than the second, otherwise `false`.
      *
-     * @param self - The first argument.
-     * @param that - The second argument.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { greaterThan, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(greaterThan(unsafeFromString("2"), unsafeFromString("3")), false)
@@ -576,11 +516,9 @@ export declare const greaterThan: {
     /**
      * Returns `true` if the first argument is greater than the second, otherwise `false`.
      *
-     * @param self - The first argument.
-     * @param that - The second argument.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { greaterThan, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(greaterThan(unsafeFromString("2"), unsafeFromString("3")), false)
@@ -596,11 +534,9 @@ export declare const greaterThan: {
 /**
  * Checks if a given `BigDecimal` is greater than or equal to the provided one.
  *
- * @param self - The first `BigDecimal` to compare with.
- * @param that - The second `BigDecimal` to compare with.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { greaterThanOrEqualTo, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(greaterThanOrEqualTo(unsafeFromString("2"), unsafeFromString("3")), false)
@@ -615,11 +551,9 @@ export declare const greaterThanOrEqualTo: {
     /**
      * Checks if a given `BigDecimal` is greater than or equal to the provided one.
      *
-     * @param self - The first `BigDecimal` to compare with.
-     * @param that - The second `BigDecimal` to compare with.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { greaterThanOrEqualTo, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(greaterThanOrEqualTo(unsafeFromString("2"), unsafeFromString("3")), false)
@@ -634,11 +568,9 @@ export declare const greaterThanOrEqualTo: {
     /**
      * Checks if a given `BigDecimal` is greater than or equal to the provided one.
      *
-     * @param self - The first `BigDecimal` to compare with.
-     * @param that - The second `BigDecimal` to compare with.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { greaterThanOrEqualTo, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(greaterThanOrEqualTo(unsafeFromString("2"), unsafeFromString("3")), false)
@@ -654,12 +586,9 @@ export declare const greaterThanOrEqualTo: {
 /**
  * Checks if a `BigDecimal` is between a `minimum` and `maximum` value (inclusive).
  *
- * @param self - The `number` to check.
- * @param minimum - The `minimum` value to check.
- * @param maximum - The `maximum` value to check.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { BigDecimal } from "effect"
  *
  * const between = BigDecimal.between({
@@ -679,12 +608,9 @@ export declare const between: {
     /**
      * Checks if a `BigDecimal` is between a `minimum` and `maximum` value (inclusive).
      *
-     * @param self - The `number` to check.
-     * @param minimum - The `minimum` value to check.
-     * @param maximum - The `maximum` value to check.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { BigDecimal } from "effect"
      *
      * const between = BigDecimal.between({
@@ -707,12 +633,9 @@ export declare const between: {
     /**
      * Checks if a `BigDecimal` is between a `minimum` and `maximum` value (inclusive).
      *
-     * @param self - The `number` to check.
-     * @param minimum - The `minimum` value to check.
-     * @param maximum - The `maximum` value to check.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { BigDecimal } from "effect"
      *
      * const between = BigDecimal.between({
@@ -740,12 +663,9 @@ export declare const between: {
  * - If the `BigDecimal` is greater than the `maximum` value, the function returns the `maximum` value.
  * - Otherwise, it returns the original `BigDecimal`.
  *
- * @param self - The `BigDecimal` to be clamped.
- * @param minimum - The lower end of the range.
- * @param maximum - The upper end of the range.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { BigDecimal } from "effect"
  *
  * const clamp = BigDecimal.clamp({
@@ -769,12 +689,9 @@ export declare const clamp: {
      * - If the `BigDecimal` is greater than the `maximum` value, the function returns the `maximum` value.
      * - Otherwise, it returns the original `BigDecimal`.
      *
-     * @param self - The `BigDecimal` to be clamped.
-     * @param minimum - The lower end of the range.
-     * @param maximum - The upper end of the range.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { BigDecimal } from "effect"
      *
      * const clamp = BigDecimal.clamp({
@@ -801,12 +718,9 @@ export declare const clamp: {
      * - If the `BigDecimal` is greater than the `maximum` value, the function returns the `maximum` value.
      * - Otherwise, it returns the original `BigDecimal`.
      *
-     * @param self - The `BigDecimal` to be clamped.
-     * @param minimum - The lower end of the range.
-     * @param maximum - The upper end of the range.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { BigDecimal } from "effect"
      *
      * const clamp = BigDecimal.clamp({
@@ -830,11 +744,9 @@ export declare const clamp: {
 /**
  * Returns the minimum between two `BigDecimal`s.
  *
- * @param self - The first `BigDecimal`.
- * @param that - The second `BigDecimal`.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { min, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(min(unsafeFromString("2"), unsafeFromString("3")), unsafeFromString("2"))
@@ -847,11 +759,9 @@ export declare const min: {
     /**
      * Returns the minimum between two `BigDecimal`s.
      *
-     * @param self - The first `BigDecimal`.
-     * @param that - The second `BigDecimal`.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { min, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(min(unsafeFromString("2"), unsafeFromString("3")), unsafeFromString("2"))
@@ -864,11 +774,9 @@ export declare const min: {
     /**
      * Returns the minimum between two `BigDecimal`s.
      *
-     * @param self - The first `BigDecimal`.
-     * @param that - The second `BigDecimal`.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { min, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(min(unsafeFromString("2"), unsafeFromString("3")), unsafeFromString("2"))
@@ -882,11 +790,9 @@ export declare const min: {
 /**
  * Returns the maximum between two `BigDecimal`s.
  *
- * @param self - The first `BigDecimal`.
- * @param that - The second `BigDecimal`.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { max, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(max(unsafeFromString("2"), unsafeFromString("3")), unsafeFromString("3"))
@@ -899,11 +805,9 @@ export declare const max: {
     /**
      * Returns the maximum between two `BigDecimal`s.
      *
-     * @param self - The first `BigDecimal`.
-     * @param that - The second `BigDecimal`.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { max, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(max(unsafeFromString("2"), unsafeFromString("3")), unsafeFromString("3"))
@@ -916,11 +820,9 @@ export declare const max: {
     /**
      * Returns the maximum between two `BigDecimal`s.
      *
-     * @param self - The first `BigDecimal`.
-     * @param that - The second `BigDecimal`.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { max, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(max(unsafeFromString("2"), unsafeFromString("3")), unsafeFromString("3"))
@@ -934,10 +836,9 @@ export declare const max: {
 /**
  * Determines the sign of a given `BigDecimal`.
  *
- * @param n - The `BigDecimal` to determine the sign of.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { sign, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(sign(unsafeFromString("-5")), -1)
@@ -952,10 +853,9 @@ export declare const sign: (n: BigDecimal) => Ordering;
 /**
  * Determines the absolute value of a given `BigDecimal`.
  *
- * @param n - The `BigDecimal` to determine the absolute value of.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { abs, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(abs(unsafeFromString("-5")), unsafeFromString("5"))
@@ -970,10 +870,9 @@ export declare const abs: (n: BigDecimal) => BigDecimal;
 /**
  * Provides a negate operation on `BigDecimal`s.
  *
- * @param n - The `BigDecimal` to negate.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { negate, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(negate(unsafeFromString("3")), unsafeFromString("-3"))
@@ -989,11 +888,9 @@ export declare const negate: (n: BigDecimal) => BigDecimal;
  *
  * If the divisor is `0`, the result will be `None`.
  *
- * @param self - The dividend.
- * @param divisor - The divisor.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { BigDecimal, Option } from "effect"
  *
  * assert.deepStrictEqual(BigDecimal.remainder(BigDecimal.unsafeFromString("2"), BigDecimal.unsafeFromString("2")), Option.some(BigDecimal.unsafeFromString("0")))
@@ -1010,11 +907,9 @@ export declare const remainder: {
      *
      * If the divisor is `0`, the result will be `None`.
      *
-     * @param self - The dividend.
-     * @param divisor - The divisor.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { BigDecimal, Option } from "effect"
      *
      * assert.deepStrictEqual(BigDecimal.remainder(BigDecimal.unsafeFromString("2"), BigDecimal.unsafeFromString("2")), Option.some(BigDecimal.unsafeFromString("0")))
@@ -1031,11 +926,9 @@ export declare const remainder: {
      *
      * If the divisor is `0`, the result will be `None`.
      *
-     * @param self - The dividend.
-     * @param divisor - The divisor.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { BigDecimal, Option } from "effect"
      *
      * assert.deepStrictEqual(BigDecimal.remainder(BigDecimal.unsafeFromString("2"), BigDecimal.unsafeFromString("2")), Option.some(BigDecimal.unsafeFromString("0")))
@@ -1053,11 +946,9 @@ export declare const remainder: {
  *
  * Throws a `RangeError` if the divisor is `0`.
  *
- * @param self - The dividend.
- * @param divisor - The divisor.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { unsafeRemainder, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(unsafeRemainder(unsafeFromString("2"), unsafeFromString("2")), unsafeFromString("0"))
@@ -1074,11 +965,9 @@ export declare const unsafeRemainder: {
      *
      * Throws a `RangeError` if the divisor is `0`.
      *
-     * @param self - The dividend.
-     * @param divisor - The divisor.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { unsafeRemainder, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(unsafeRemainder(unsafeFromString("2"), unsafeFromString("2")), unsafeFromString("0"))
@@ -1095,11 +984,9 @@ export declare const unsafeRemainder: {
      *
      * Throws a `RangeError` if the divisor is `0`.
      *
-     * @param self - The dividend.
-     * @param divisor - The divisor.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { unsafeRemainder, unsafeFromString } from "effect/BigDecimal"
      *
      * assert.deepStrictEqual(unsafeRemainder(unsafeFromString("2"), unsafeFromString("2")), unsafeFromString("0"))
@@ -1142,8 +1029,6 @@ export declare const equals: {
 /**
  * Creates a `BigDecimal` from a `bigint` value.
  *
- * @param value - The `bigint` value to create a `BigDecimal` from.
- *
  * @since 2.0.0
  * @category constructors
  */
@@ -1156,10 +1041,9 @@ export declare const fromBigInt: (n: bigint) => BigDecimal;
  *
  * 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 * as assert from "node:assert"
  * import { unsafeFromNumber, make } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(unsafeFromNumber(123), make(123n, 0))
@@ -1178,8 +1062,6 @@ export declare const unsafeFromNumber: (n: number) => BigDecimal;
  *
  * 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.
@@ -1193,10 +1075,9 @@ export declare const fromNumber: (n: number) => BigDecimal;
  *
  * Returns `None` if the number is not finite (`NaN`, `+Infinity` or `-Infinity`).
  *
- * @param n - The `number` value to create a `BigDecimal` from.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { BigDecimal, Option } from "effect"
  *
  * assert.deepStrictEqual(BigDecimal.safeFromNumber(123), Option.some(BigDecimal.make(123n, 0)))
@@ -1211,10 +1092,9 @@ 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 * as assert from "node:assert"
  * import { BigDecimal, Option } from "effect"
  *
  * assert.deepStrictEqual(BigDecimal.fromString("123"), Option.some(BigDecimal.make(123n, 0)))
@@ -1229,10 +1109,9 @@ export declare const fromString: (s: string) => Option.Option<BigDecimal>;
 /**
  * Parses a numerical `string` into a `BigDecimal`.
  *
- * @param s - The `string` to parse.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { unsafeFromString, make } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(unsafeFromString("123"), make(123n, 0))
@@ -1250,10 +1129,9 @@ export declare const unsafeFromString: (s: string) => BigDecimal;
  * 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 * as assert from "node:assert"
  * import { format, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(format(unsafeFromString("-5")), "-5")
@@ -1268,10 +1146,9 @@ export declare const format: (n: BigDecimal) => string;
 /**
  * Formats a given `BigDecimal` as a `string` in scientific notation.
  *
- * @param n - The `BigDecimal` to format.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { toExponential, make } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(toExponential(make(123456n, -5)), "1.23456e+10")
@@ -1286,10 +1163,9 @@ export declare const toExponential: (n: BigDecimal) => string;
  *
  * This function will produce incorrect results if the `BigDecimal` exceeds the 64-bit range of a `number`.
  *
- * @param n - The `BigDecimal` to convert.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { unsafeToNumber, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(unsafeToNumber(unsafeFromString("123.456")), 123.456)
@@ -1302,10 +1178,9 @@ export declare const unsafeToNumber: (n: BigDecimal) => number;
 /**
  * Checks if a given `BigDecimal` is an integer.
  *
- * @param n - The `BigDecimal` to check.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { isInteger, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(isInteger(unsafeFromString("0")), true)
@@ -1320,10 +1195,9 @@ export declare const isInteger: (n: BigDecimal) => boolean;
 /**
  * Checks if a given `BigDecimal` is `0`.
  *
- * @param n - The `BigDecimal` to check.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { isZero, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(isZero(unsafeFromString("0")), true)
@@ -1337,10 +1211,9 @@ export declare const isZero: (n: BigDecimal) => boolean;
 /**
  * Checks if a given `BigDecimal` is negative.
  *
- * @param n - The `BigDecimal` to check.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { isNegative, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(isNegative(unsafeFromString("-1")), true)
@@ -1355,10 +1228,9 @@ export declare const isNegative: (n: BigDecimal) => boolean;
 /**
  * Checks if a given `BigDecimal` is positive.
  *
- * @param n - The `BigDecimal` to check.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { isPositive, unsafeFromString } from "effect/BigDecimal"
  *
  * assert.deepStrictEqual(isPositive(unsafeFromString("-1")), false)