effect 3.13.8 → 3.13.9

package/dist/dts/BigInt.d.ts

@@ -12,10 +12,9 @@ import type { Ordering } from "./Ordering.js";
 /**
  * Tests if a value is a `bigint`.
  *
- * @param input - The value to test.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { isBigInt } from "effect/BigInt"
  *
  * assert.deepStrictEqual(isBigInt(1n), true)
@@ -29,11 +28,9 @@ export declare const isBigInt: (u: unknown) => u is bigint;
 /**
  * Provides an addition operation on `bigint`s.
  *
- * @param self - The first operand.
- * @param that - The second operand.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { sum } from "effect/BigInt"
  *
  * assert.deepStrictEqual(sum(2n, 3n), 5n)
@@ -46,11 +43,9 @@ export declare const sum: {
     /**
      * Provides an addition operation on `bigint`s.
      *
-     * @param self - The first operand.
-     * @param that - The second operand.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { sum } from "effect/BigInt"
      *
      * assert.deepStrictEqual(sum(2n, 3n), 5n)
@@ -63,11 +58,9 @@ export declare const sum: {
     /**
      * Provides an addition operation on `bigint`s.
      *
-     * @param self - The first operand.
-     * @param that - The second operand.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { sum } from "effect/BigInt"
      *
      * assert.deepStrictEqual(sum(2n, 3n), 5n)
@@ -81,11 +74,9 @@ export declare const sum: {
 /**
  * Provides a multiplication operation on `bigint`s.
  *
- * @param self - The first operand.
- * @param that - The second operand.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { multiply } from "effect/BigInt"
  *
  * assert.deepStrictEqual(multiply(2n, 3n), 6n)
@@ -98,11 +89,9 @@ export declare const multiply: {
     /**
      * Provides a multiplication operation on `bigint`s.
      *
-     * @param self - The first operand.
-     * @param that - The second operand.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { multiply } from "effect/BigInt"
      *
      * assert.deepStrictEqual(multiply(2n, 3n), 6n)
@@ -115,11 +104,9 @@ export declare const multiply: {
     /**
      * Provides a multiplication operation on `bigint`s.
      *
-     * @param self - The first operand.
-     * @param that - The second operand.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { multiply } from "effect/BigInt"
      *
      * assert.deepStrictEqual(multiply(2n, 3n), 6n)
@@ -133,11 +120,9 @@ export declare const multiply: {
 /**
  * Provides a subtraction operation on `bigint`s.
  *
- * @param self - The first operand.
- * @param that - The second operand.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { subtract } from "effect/BigInt"
  *
  * assert.deepStrictEqual(subtract(2n, 3n), -1n)
@@ -150,11 +135,9 @@ export declare const subtract: {
     /**
      * Provides a subtraction operation on `bigint`s.
      *
-     * @param self - The first operand.
-     * @param that - The second operand.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { subtract } from "effect/BigInt"
      *
      * assert.deepStrictEqual(subtract(2n, 3n), -1n)
@@ -167,11 +150,9 @@ export declare const subtract: {
     /**
      * Provides a subtraction operation on `bigint`s.
      *
-     * @param self - The first operand.
-     * @param that - The second operand.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { subtract } from "effect/BigInt"
      *
      * assert.deepStrictEqual(subtract(2n, 3n), -1n)
@@ -190,11 +171,9 @@ export declare const subtract: {
  *
  * Returns `None` if the divisor is `0n`.
  *
- * @param self - The dividend operand.
- * @param that - The divisor operand.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { BigInt, Option } from "effect"
  *
  * assert.deepStrictEqual(BigInt.divide(6n, 3n), Option.some(2n))
@@ -213,11 +192,9 @@ export declare const divide: {
      *
      * Returns `None` if the divisor is `0n`.
      *
-     * @param self - The dividend operand.
-     * @param that - The divisor operand.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { BigInt, Option } from "effect"
      *
      * assert.deepStrictEqual(BigInt.divide(6n, 3n), Option.some(2n))
@@ -236,11 +213,9 @@ export declare const divide: {
      *
      * Returns `None` if the divisor is `0n`.
      *
-     * @param self - The dividend operand.
-     * @param that - The divisor operand.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { BigInt, Option } from "effect"
      *
      * assert.deepStrictEqual(BigInt.divide(6n, 3n), Option.some(2n))
@@ -260,11 +235,9 @@ export declare const divide: {
  *
  * Throws a `RangeError` if the divisor is `0n`.
  *
- * @param self - The dividend operand.
- * @param that - The divisor operand.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { unsafeDivide } from "effect/BigInt"
  *
  * assert.deepStrictEqual(unsafeDivide(6n, 3n), 2n)
@@ -283,11 +256,9 @@ export declare const unsafeDivide: {
      *
      * Throws a `RangeError` if the divisor is `0n`.
      *
-     * @param self - The dividend operand.
-     * @param that - The divisor operand.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { unsafeDivide } from "effect/BigInt"
      *
      * assert.deepStrictEqual(unsafeDivide(6n, 3n), 2n)
@@ -306,11 +277,9 @@ export declare const unsafeDivide: {
      *
      * Throws a `RangeError` if the divisor is `0n`.
      *
-     * @param self - The dividend operand.
-     * @param that - The divisor operand.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { unsafeDivide } from "effect/BigInt"
      *
      * assert.deepStrictEqual(unsafeDivide(6n, 3n), 2n)
@@ -325,10 +294,9 @@ export declare const unsafeDivide: {
 /**
  * Returns the result of adding `1n` to a given number.
  *
- * @param n - A `bigint` to be incremented.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { increment } from "effect/BigInt"
  *
  * assert.deepStrictEqual(increment(2n), 3n)
@@ -341,10 +309,9 @@ export declare const increment: (n: bigint) => bigint;
 /**
  * Decrements a number by `1n`.
  *
- * @param n - A `bigint` to be decremented.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { decrement } from "effect/BigInt"
  *
  * assert.deepStrictEqual(decrement(3n), 2n)
@@ -367,11 +334,9 @@ export declare const Order: order.Order<bigint>;
 /**
  * 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 } from "effect/BigInt"
  *
  * assert.deepStrictEqual(lessThan(2n, 3n), true)
@@ -386,11 +351,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 } from "effect/BigInt"
      *
      * assert.deepStrictEqual(lessThan(2n, 3n), true)
@@ -405,11 +368,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 } from "effect/BigInt"
      *
      * assert.deepStrictEqual(lessThan(2n, 3n), true)
@@ -425,11 +386,9 @@ export declare const lessThan: {
 /**
  * Returns a function that checks if a given `bigint` is less than or equal to the provided one.
  *
- * @param self - The first `bigint` to compare with.
- * @param that - The second `bigint` to compare with.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { lessThanOrEqualTo } from "effect/BigInt"
  *
  * assert.deepStrictEqual(lessThanOrEqualTo(2n, 3n), true)
@@ -444,11 +403,9 @@ export declare const lessThanOrEqualTo: {
     /**
      * Returns a function that checks if a given `bigint` is less than or equal to the provided one.
      *
-     * @param self - The first `bigint` to compare with.
-     * @param that - The second `bigint` to compare with.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { lessThanOrEqualTo } from "effect/BigInt"
      *
      * assert.deepStrictEqual(lessThanOrEqualTo(2n, 3n), true)
@@ -463,11 +420,9 @@ export declare const lessThanOrEqualTo: {
     /**
      * Returns a function that checks if a given `bigint` is less than or equal to the provided one.
      *
-     * @param self - The first `bigint` to compare with.
-     * @param that - The second `bigint` to compare with.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { lessThanOrEqualTo } from "effect/BigInt"
      *
      * assert.deepStrictEqual(lessThanOrEqualTo(2n, 3n), true)
@@ -483,11 +438,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 } from "effect/BigInt"
  *
  * assert.deepStrictEqual(greaterThan(2n, 3n), false)
@@ -502,11 +455,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 } from "effect/BigInt"
      *
      * assert.deepStrictEqual(greaterThan(2n, 3n), false)
@@ -521,11 +472,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 } from "effect/BigInt"
      *
      * assert.deepStrictEqual(greaterThan(2n, 3n), false)
@@ -541,11 +490,9 @@ export declare const greaterThan: {
 /**
  * Returns a function that checks if a given `bigint` is greater than or equal to the provided one.
  *
- * @param self - The first `bigint` to compare with.
- * @param that - The second `bigint` to compare with.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { greaterThanOrEqualTo } from "effect/BigInt"
  *
  * assert.deepStrictEqual(greaterThanOrEqualTo(2n, 3n), false)
@@ -560,11 +507,9 @@ export declare const greaterThanOrEqualTo: {
     /**
      * Returns a function that checks if a given `bigint` is greater than or equal to the provided one.
      *
-     * @param self - The first `bigint` to compare with.
-     * @param that - The second `bigint` to compare with.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { greaterThanOrEqualTo } from "effect/BigInt"
      *
      * assert.deepStrictEqual(greaterThanOrEqualTo(2n, 3n), false)
@@ -579,11 +524,9 @@ export declare const greaterThanOrEqualTo: {
     /**
      * Returns a function that checks if a given `bigint` is greater than or equal to the provided one.
      *
-     * @param self - The first `bigint` to compare with.
-     * @param that - The second `bigint` to compare with.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { greaterThanOrEqualTo } from "effect/BigInt"
      *
      * assert.deepStrictEqual(greaterThanOrEqualTo(2n, 3n), false)
@@ -599,12 +542,9 @@ export declare const greaterThanOrEqualTo: {
 /**
  * Checks if a `bigint` 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 { BigInt } from "effect"
  *
  * const between = BigInt.between({ minimum: 0n, maximum: 5n })
@@ -621,12 +561,9 @@ export declare const between: {
     /**
      * Checks if a `bigint` 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 { BigInt } from "effect"
      *
      * const between = BigInt.between({ minimum: 0n, maximum: 5n })
@@ -646,12 +583,9 @@ export declare const between: {
     /**
      * Checks if a `bigint` 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 { BigInt } from "effect"
      *
      * const between = BigInt.between({ minimum: 0n, maximum: 5n })
@@ -676,12 +610,9 @@ export declare const between: {
  * - If the `bigint` is greater than the `maximum` value, the function returns the `maximum` value.
  * - Otherwise, it returns the original `bigint`.
  *
- * @param self - The `bigint` 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 { BigInt } from "effect"
  *
  * const clamp = BigInt.clamp({ minimum: 1n, maximum: 5n })
@@ -701,12 +632,9 @@ export declare const clamp: {
      * - If the `bigint` is greater than the `maximum` value, the function returns the `maximum` value.
      * - Otherwise, it returns the original `bigint`.
      *
-     * @param self - The `bigint` 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 { BigInt } from "effect"
      *
      * const clamp = BigInt.clamp({ minimum: 1n, maximum: 5n })
@@ -729,12 +657,9 @@ export declare const clamp: {
      * - If the `bigint` is greater than the `maximum` value, the function returns the `maximum` value.
      * - Otherwise, it returns the original `bigint`.
      *
-     * @param self - The `bigint` 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 { BigInt } from "effect"
      *
      * const clamp = BigInt.clamp({ minimum: 1n, maximum: 5n })
@@ -754,11 +679,9 @@ export declare const clamp: {
 /**
  * Returns the minimum between two `bigint`s.
  *
- * @param self - The first `bigint`.
- * @param that - The second `bigint`.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { min } from "effect/BigInt"
  *
  * assert.deepStrictEqual(min(2n, 3n), 2n)
@@ -770,11 +693,9 @@ export declare const min: {
     /**
      * Returns the minimum between two `bigint`s.
      *
-     * @param self - The first `bigint`.
-     * @param that - The second `bigint`.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { min } from "effect/BigInt"
      *
      * assert.deepStrictEqual(min(2n, 3n), 2n)
@@ -786,11 +707,9 @@ export declare const min: {
     /**
      * Returns the minimum between two `bigint`s.
      *
-     * @param self - The first `bigint`.
-     * @param that - The second `bigint`.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { min } from "effect/BigInt"
      *
      * assert.deepStrictEqual(min(2n, 3n), 2n)
@@ -803,11 +722,9 @@ export declare const min: {
 /**
  * Returns the maximum between two `bigint`s.
  *
- * @param self - The first `bigint`.
- * @param that - The second `bigint`.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { max } from "effect/BigInt"
  *
  * assert.deepStrictEqual(max(2n, 3n), 3n)
@@ -819,11 +736,9 @@ export declare const max: {
     /**
      * Returns the maximum between two `bigint`s.
      *
-     * @param self - The first `bigint`.
-     * @param that - The second `bigint`.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { max } from "effect/BigInt"
      *
      * assert.deepStrictEqual(max(2n, 3n), 3n)
@@ -835,11 +750,9 @@ export declare const max: {
     /**
      * Returns the maximum between two `bigint`s.
      *
-     * @param self - The first `bigint`.
-     * @param that - The second `bigint`.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { max } from "effect/BigInt"
      *
      * assert.deepStrictEqual(max(2n, 3n), 3n)
@@ -852,10 +765,9 @@ export declare const max: {
 /**
  * Determines the sign of a given `bigint`.
  *
- * @param n - The `bigint` to determine the sign of.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { sign } from "effect/BigInt"
  *
  * assert.deepStrictEqual(sign(-5n), -1)
@@ -870,10 +782,9 @@ export declare const sign: (n: bigint) => Ordering;
 /**
  * Determines the absolute value of a given `bigint`.
  *
- * @param n - The `bigint` to determine the absolute value of.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { abs } from "effect/BigInt"
  *
  * assert.deepStrictEqual(abs(-5n), 5n)
@@ -888,11 +799,9 @@ export declare const abs: (n: bigint) => bigint;
 /**
  * Determines the greatest common divisor of two `bigint`s.
  *
- * @param a - The first `bigint`.
- * @param b - The second `bigint`.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { gcd } from "effect/BigInt"
  *
  * assert.deepStrictEqual(gcd(2n, 3n), 1n)
@@ -907,11 +816,9 @@ export declare const gcd: {
     /**
      * Determines the greatest common divisor of two `bigint`s.
      *
-     * @param a - The first `bigint`.
-     * @param b - The second `bigint`.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { gcd } from "effect/BigInt"
      *
      * assert.deepStrictEqual(gcd(2n, 3n), 1n)
@@ -926,11 +833,9 @@ export declare const gcd: {
     /**
      * Determines the greatest common divisor of two `bigint`s.
      *
-     * @param a - The first `bigint`.
-     * @param b - The second `bigint`.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { gcd } from "effect/BigInt"
      *
      * assert.deepStrictEqual(gcd(2n, 3n), 1n)
@@ -946,11 +851,9 @@ export declare const gcd: {
 /**
  * Determines the least common multiple of two `bigint`s.
  *
- * @param a - The first `bigint`.
- * @param b - The second `bigint`.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { lcm } from "effect/BigInt"
  *
  * assert.deepStrictEqual(lcm(2n, 3n), 6n)
@@ -965,11 +868,9 @@ export declare const lcm: {
     /**
      * Determines the least common multiple of two `bigint`s.
      *
-     * @param a - The first `bigint`.
-     * @param b - The second `bigint`.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { lcm } from "effect/BigInt"
      *
      * assert.deepStrictEqual(lcm(2n, 3n), 6n)
@@ -984,11 +885,9 @@ export declare const lcm: {
     /**
      * Determines the least common multiple of two `bigint`s.
      *
-     * @param a - The first `bigint`.
-     * @param b - The second `bigint`.
-     *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { lcm } from "effect/BigInt"
      *
      * assert.deepStrictEqual(lcm(2n, 3n), 6n)
@@ -1004,10 +903,9 @@ export declare const lcm: {
 /**
  * Determines the square root of a given `bigint` unsafely. Throws if the given `bigint` is negative.
  *
- * @param n - The `bigint` to determine the square root of.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { unsafeSqrt } from "effect/BigInt"
  *
  * assert.deepStrictEqual(unsafeSqrt(4n), 2n)
@@ -1022,10 +920,9 @@ export declare const unsafeSqrt: (n: bigint) => bigint;
 /**
  * Determines the square root of a given `bigint` safely. Returns `none` if the given `bigint` is negative.
  *
- * @param n - The `bigint` to determine the square root of.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { BigInt, Option } from "effect"
  *
  * assert.deepStrictEqual(BigInt.sqrt(4n), Option.some(2n))
@@ -1041,10 +938,9 @@ export declare const sqrt: (n: bigint) => Option.Option<bigint>;
 /**
  * Takes an `Iterable` of `bigint`s and returns their sum as a single `bigint
  *
- * @param collection - The collection of `bigint`s to sum.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { sumAll } from "effect/BigInt"
  *
  * assert.deepStrictEqual(sumAll([2n, 3n, 4n]), 9n)
@@ -1057,10 +953,9 @@ export declare const sumAll: (collection: Iterable<bigint>) => bigint;
 /**
  * Takes an `Iterable` of `bigint`s and returns their multiplication as a single `number`.
  *
- * @param collection - The collection of `bigint`s to multiply.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { multiplyAll } from "effect/BigInt"
  *
  * assert.deepStrictEqual(multiplyAll([2n, 3n, 4n]), 24n)
@@ -1077,10 +972,9 @@ export declare const multiplyAll: (collection: Iterable<bigint>) => bigint;
  * and `Number.MIN_SAFE_INTEGER`), it returns `Option.none()`. Otherwise, it converts the `bigint`
  * to a number and returns `Option.some(number)`.
  *
- * @param b - The `bigint` to be converted to a `number`.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { BigInt as BI, Option } from "effect"
  *
  * assert.deepStrictEqual(BI.toNumber(BigInt(42)), Option.some(42))
@@ -1098,10 +992,9 @@ export declare const toNumber: (b: bigint) => Option.Option<number>;
  * If the string is empty or contains characters that cannot be converted into a `bigint`,
  * it returns `Option.none()`, otherwise, it returns `Option.some(bigint)`.
  *
- * @param s - The string to be converted to a `bigint`.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { BigInt as BI, Option } from "effect"
  *
  * assert.deepStrictEqual(BI.fromString("42"), Option.some(BigInt(42)))
@@ -1120,10 +1013,9 @@ export declare const fromString: (s: string) => Option.Option<bigint>;
  * and `Number.MIN_SAFE_INTEGER`), it returns `Option.none()`. Otherwise, it attempts to
  * convert the number to a `bigint` and returns `Option.some(bigint)`.
  *
- * @param n - The number to be converted to a `bigint`.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { BigInt as BI, Option } from "effect"
  *
  * assert.deepStrictEqual(BI.fromNumber(42), Option.some(BigInt(42)))