effect 3.10.18 → 3.11.0

package/dist/dts/BigInt.d.ts

@@ -15,10 +15,12 @@ import type { Ordering } from "./Ordering.js";
  * @param input - The value to test.
  *
  * @example
+ * ```ts
  * import { isBigInt } from "effect/BigInt"
  *
  * assert.deepStrictEqual(isBigInt(1n), true)
  * assert.deepStrictEqual(isBigInt(1), false)
+ * ```
  *
  * @category guards
  * @since 2.0.0
@@ -31,9 +33,11 @@ export declare const isBigInt: (u: unknown) => u is bigint;
  * @param that - The second operand.
  *
  * @example
+ * ```ts
  * import { sum } from "effect/BigInt"
  *
  * assert.deepStrictEqual(sum(2n, 3n), 5n)
+ * ```
  *
  * @category math
  * @since 2.0.0
@@ -46,9 +50,11 @@ export declare const sum: {
      * @param that - The second operand.
      *
      * @example
+     * ```ts
      * import { sum } from "effect/BigInt"
      *
      * assert.deepStrictEqual(sum(2n, 3n), 5n)
+     * ```
      *
      * @category math
      * @since 2.0.0
@@ -61,9 +67,11 @@ export declare const sum: {
      * @param that - The second operand.
      *
      * @example
+     * ```ts
      * import { sum } from "effect/BigInt"
      *
      * assert.deepStrictEqual(sum(2n, 3n), 5n)
+     * ```
      *
      * @category math
      * @since 2.0.0
@@ -77,9 +85,11 @@ export declare const sum: {
  * @param that - The second operand.
  *
  * @example
+ * ```ts
  * import { multiply } from "effect/BigInt"
  *
  * assert.deepStrictEqual(multiply(2n, 3n), 6n)
+ * ```
  *
  * @category math
  * @since 2.0.0
@@ -92,9 +102,11 @@ export declare const multiply: {
      * @param that - The second operand.
      *
      * @example
+     * ```ts
      * import { multiply } from "effect/BigInt"
      *
      * assert.deepStrictEqual(multiply(2n, 3n), 6n)
+     * ```
      *
      * @category math
      * @since 2.0.0
@@ -107,9 +119,11 @@ export declare const multiply: {
      * @param that - The second operand.
      *
      * @example
+     * ```ts
      * import { multiply } from "effect/BigInt"
      *
      * assert.deepStrictEqual(multiply(2n, 3n), 6n)
+     * ```
      *
      * @category math
      * @since 2.0.0
@@ -123,9 +137,11 @@ export declare const multiply: {
  * @param that - The second operand.
  *
  * @example
+ * ```ts
  * import { subtract } from "effect/BigInt"
  *
  * assert.deepStrictEqual(subtract(2n, 3n), -1n)
+ * ```
  *
  * @category math
  * @since 2.0.0
@@ -138,9 +154,11 @@ export declare const subtract: {
      * @param that - The second operand.
      *
      * @example
+     * ```ts
      * import { subtract } from "effect/BigInt"
      *
      * assert.deepStrictEqual(subtract(2n, 3n), -1n)
+     * ```
      *
      * @category math
      * @since 2.0.0
@@ -153,9 +171,11 @@ export declare const subtract: {
      * @param that - The second operand.
      *
      * @example
+     * ```ts
      * import { subtract } from "effect/BigInt"
      *
      * assert.deepStrictEqual(subtract(2n, 3n), -1n)
+     * ```
      *
      * @category math
      * @since 2.0.0
@@ -174,10 +194,12 @@ export declare const subtract: {
  * @param that - The divisor operand.
  *
  * @example
+ * ```ts
  * import { BigInt, Option } from "effect"
  *
  * assert.deepStrictEqual(BigInt.divide(6n, 3n), Option.some(2n))
  * assert.deepStrictEqual(BigInt.divide(6n, 0n), Option.none())
+ * ```
  *
  * @category math
  * @since 2.0.0
@@ -195,10 +217,12 @@ export declare const divide: {
      * @param that - The divisor operand.
      *
      * @example
+     * ```ts
      * import { BigInt, Option } from "effect"
      *
      * assert.deepStrictEqual(BigInt.divide(6n, 3n), Option.some(2n))
      * assert.deepStrictEqual(BigInt.divide(6n, 0n), Option.none())
+     * ```
      *
      * @category math
      * @since 2.0.0
@@ -216,10 +240,12 @@ export declare const divide: {
      * @param that - The divisor operand.
      *
      * @example
+     * ```ts
      * import { BigInt, Option } from "effect"
      *
      * assert.deepStrictEqual(BigInt.divide(6n, 3n), Option.some(2n))
      * assert.deepStrictEqual(BigInt.divide(6n, 0n), Option.none())
+     * ```
      *
      * @category math
      * @since 2.0.0
@@ -238,10 +264,12 @@ export declare const divide: {
  * @param that - The divisor operand.
  *
  * @example
+ * ```ts
  * import { unsafeDivide } from "effect/BigInt"
  *
  * assert.deepStrictEqual(unsafeDivide(6n, 3n), 2n)
  * assert.deepStrictEqual(unsafeDivide(6n, 4n), 1n)
+ * ```
  *
  * @category math
  * @since 2.0.0
@@ -259,10 +287,12 @@ export declare const unsafeDivide: {
      * @param that - The divisor operand.
      *
      * @example
+     * ```ts
      * import { unsafeDivide } from "effect/BigInt"
      *
      * assert.deepStrictEqual(unsafeDivide(6n, 3n), 2n)
      * assert.deepStrictEqual(unsafeDivide(6n, 4n), 1n)
+     * ```
      *
      * @category math
      * @since 2.0.0
@@ -280,10 +310,12 @@ export declare const unsafeDivide: {
      * @param that - The divisor operand.
      *
      * @example
+     * ```ts
      * import { unsafeDivide } from "effect/BigInt"
      *
      * assert.deepStrictEqual(unsafeDivide(6n, 3n), 2n)
      * assert.deepStrictEqual(unsafeDivide(6n, 4n), 1n)
+     * ```
      *
      * @category math
      * @since 2.0.0
@@ -296,9 +328,11 @@ export declare const unsafeDivide: {
  * @param n - A `bigint` to be incremented.
  *
  * @example
+ * ```ts
  * import { increment } from "effect/BigInt"
  *
  * assert.deepStrictEqual(increment(2n), 3n)
+ * ```
  *
  * @category math
  * @since 2.0.0
@@ -310,9 +344,11 @@ export declare const increment: (n: bigint) => bigint;
  * @param n - A `bigint` to be decremented.
  *
  * @example
+ * ```ts
  * import { decrement } from "effect/BigInt"
  *
  * assert.deepStrictEqual(decrement(3n), 2n)
+ * ```
  *
  * @category math
  * @since 2.0.0
@@ -335,11 +371,13 @@ export declare const Order: order.Order<bigint>;
  * @param that - The second argument.
  *
  * @example
+ * ```ts
  * import { lessThan } from "effect/BigInt"
  *
  * assert.deepStrictEqual(lessThan(2n, 3n), true)
  * assert.deepStrictEqual(lessThan(3n, 3n), false)
  * assert.deepStrictEqual(lessThan(4n, 3n), false)
+ * ```
  *
  * @category predicates
  * @since 2.0.0
@@ -352,11 +390,13 @@ export declare const lessThan: {
      * @param that - The second argument.
      *
      * @example
+     * ```ts
      * import { lessThan } from "effect/BigInt"
      *
      * assert.deepStrictEqual(lessThan(2n, 3n), true)
      * assert.deepStrictEqual(lessThan(3n, 3n), false)
      * assert.deepStrictEqual(lessThan(4n, 3n), false)
+     * ```
      *
      * @category predicates
      * @since 2.0.0
@@ -369,11 +409,13 @@ export declare const lessThan: {
      * @param that - The second argument.
      *
      * @example
+     * ```ts
      * import { lessThan } from "effect/BigInt"
      *
      * assert.deepStrictEqual(lessThan(2n, 3n), true)
      * assert.deepStrictEqual(lessThan(3n, 3n), false)
      * assert.deepStrictEqual(lessThan(4n, 3n), false)
+     * ```
      *
      * @category predicates
      * @since 2.0.0
@@ -387,11 +429,13 @@ export declare const lessThan: {
  * @param that - The second `bigint` to compare with.
  *
  * @example
+ * ```ts
  * import { lessThanOrEqualTo } from "effect/BigInt"
  *
  * assert.deepStrictEqual(lessThanOrEqualTo(2n, 3n), true)
  * assert.deepStrictEqual(lessThanOrEqualTo(3n, 3n), true)
  * assert.deepStrictEqual(lessThanOrEqualTo(4n, 3n), false)
+ * ```
  *
  * @category predicates
  * @since 2.0.0
@@ -404,11 +448,13 @@ export declare const lessThanOrEqualTo: {
      * @param that - The second `bigint` to compare with.
      *
      * @example
+     * ```ts
      * import { lessThanOrEqualTo } from "effect/BigInt"
      *
      * assert.deepStrictEqual(lessThanOrEqualTo(2n, 3n), true)
      * assert.deepStrictEqual(lessThanOrEqualTo(3n, 3n), true)
      * assert.deepStrictEqual(lessThanOrEqualTo(4n, 3n), false)
+     * ```
      *
      * @category predicates
      * @since 2.0.0
@@ -421,11 +467,13 @@ export declare const lessThanOrEqualTo: {
      * @param that - The second `bigint` to compare with.
      *
      * @example
+     * ```ts
      * import { lessThanOrEqualTo } from "effect/BigInt"
      *
      * assert.deepStrictEqual(lessThanOrEqualTo(2n, 3n), true)
      * assert.deepStrictEqual(lessThanOrEqualTo(3n, 3n), true)
      * assert.deepStrictEqual(lessThanOrEqualTo(4n, 3n), false)
+     * ```
      *
      * @category predicates
      * @since 2.0.0
@@ -439,11 +487,13 @@ export declare const lessThanOrEqualTo: {
  * @param that - The second argument.
  *
  * @example
+ * ```ts
  * import { greaterThan } from "effect/BigInt"
  *
  * assert.deepStrictEqual(greaterThan(2n, 3n), false)
  * assert.deepStrictEqual(greaterThan(3n, 3n), false)
  * assert.deepStrictEqual(greaterThan(4n, 3n), true)
+ * ```
  *
  * @category predicates
  * @since 2.0.0
@@ -456,11 +506,13 @@ export declare const greaterThan: {
      * @param that - The second argument.
      *
      * @example
+     * ```ts
      * import { greaterThan } from "effect/BigInt"
      *
      * assert.deepStrictEqual(greaterThan(2n, 3n), false)
      * assert.deepStrictEqual(greaterThan(3n, 3n), false)
      * assert.deepStrictEqual(greaterThan(4n, 3n), true)
+     * ```
      *
      * @category predicates
      * @since 2.0.0
@@ -473,11 +525,13 @@ export declare const greaterThan: {
      * @param that - The second argument.
      *
      * @example
+     * ```ts
      * import { greaterThan } from "effect/BigInt"
      *
      * assert.deepStrictEqual(greaterThan(2n, 3n), false)
      * assert.deepStrictEqual(greaterThan(3n, 3n), false)
      * assert.deepStrictEqual(greaterThan(4n, 3n), true)
+     * ```
      *
      * @category predicates
      * @since 2.0.0
@@ -491,11 +545,13 @@ export declare const greaterThan: {
  * @param that - The second `bigint` to compare with.
  *
  * @example
+ * ```ts
  * import { greaterThanOrEqualTo } from "effect/BigInt"
  *
  * assert.deepStrictEqual(greaterThanOrEqualTo(2n, 3n), false)
  * assert.deepStrictEqual(greaterThanOrEqualTo(3n, 3n), true)
  * assert.deepStrictEqual(greaterThanOrEqualTo(4n, 3n), true)
+ * ```
  *
  * @category predicates
  * @since 2.0.0
@@ -508,11 +564,13 @@ export declare const greaterThanOrEqualTo: {
      * @param that - The second `bigint` to compare with.
      *
      * @example
+     * ```ts
      * import { greaterThanOrEqualTo } from "effect/BigInt"
      *
      * assert.deepStrictEqual(greaterThanOrEqualTo(2n, 3n), false)
      * assert.deepStrictEqual(greaterThanOrEqualTo(3n, 3n), true)
      * assert.deepStrictEqual(greaterThanOrEqualTo(4n, 3n), true)
+     * ```
      *
      * @category predicates
      * @since 2.0.0
@@ -525,11 +583,13 @@ export declare const greaterThanOrEqualTo: {
      * @param that - The second `bigint` to compare with.
      *
      * @example
+     * ```ts
      * import { greaterThanOrEqualTo } from "effect/BigInt"
      *
      * assert.deepStrictEqual(greaterThanOrEqualTo(2n, 3n), false)
      * assert.deepStrictEqual(greaterThanOrEqualTo(3n, 3n), true)
      * assert.deepStrictEqual(greaterThanOrEqualTo(4n, 3n), true)
+     * ```
      *
      * @category predicates
      * @since 2.0.0
@@ -544,6 +604,7 @@ export declare const greaterThanOrEqualTo: {
  * @param maximum - The `maximum` value to check.
  *
  * @example
+ * ```ts
  * import { BigInt } from "effect"
  *
  * const between = BigInt.between({ minimum: 0n, maximum: 5n })
@@ -551,6 +612,7 @@ export declare const greaterThanOrEqualTo: {
  * assert.deepStrictEqual(between(3n), true)
  * assert.deepStrictEqual(between(-1n), false)
  * assert.deepStrictEqual(between(6n), false)
+ * ```
  *
  * @category predicates
  * @since 2.0.0
@@ -564,6 +626,7 @@ export declare const between: {
      * @param maximum - The `maximum` value to check.
      *
      * @example
+     * ```ts
      * import { BigInt } from "effect"
      *
      * const between = BigInt.between({ minimum: 0n, maximum: 5n })
@@ -571,6 +634,7 @@ export declare const between: {
      * assert.deepStrictEqual(between(3n), true)
      * assert.deepStrictEqual(between(-1n), false)
      * assert.deepStrictEqual(between(6n), false)
+     * ```
      *
      * @category predicates
      * @since 2.0.0
@@ -587,6 +651,7 @@ export declare const between: {
      * @param maximum - The `maximum` value to check.
      *
      * @example
+     * ```ts
      * import { BigInt } from "effect"
      *
      * const between = BigInt.between({ minimum: 0n, maximum: 5n })
@@ -594,6 +659,7 @@ export declare const between: {
      * assert.deepStrictEqual(between(3n), true)
      * assert.deepStrictEqual(between(-1n), false)
      * assert.deepStrictEqual(between(6n), false)
+     * ```
      *
      * @category predicates
      * @since 2.0.0
@@ -615,6 +681,7 @@ export declare const between: {
  * @param maximum - The upper end of the range.
  *
  * @example
+ * ```ts
  * import { BigInt } from "effect"
  *
  * const clamp = BigInt.clamp({ minimum: 1n, maximum: 5n })
@@ -622,6 +689,7 @@ export declare const between: {
  * assert.equal(clamp(3n), 3n)
  * assert.equal(clamp(0n), 1n)
  * assert.equal(clamp(6n), 5n)
+ * ```
  *
  * @since 2.0.0
  */
@@ -638,6 +706,7 @@ export declare const clamp: {
      * @param maximum - The upper end of the range.
      *
      * @example
+     * ```ts
      * import { BigInt } from "effect"
      *
      * const clamp = BigInt.clamp({ minimum: 1n, maximum: 5n })
@@ -645,6 +714,7 @@ export declare const clamp: {
      * assert.equal(clamp(3n), 3n)
      * assert.equal(clamp(0n), 1n)
      * assert.equal(clamp(6n), 5n)
+     * ```
      *
      * @since 2.0.0
      */
@@ -664,6 +734,7 @@ export declare const clamp: {
      * @param maximum - The upper end of the range.
      *
      * @example
+     * ```ts
      * import { BigInt } from "effect"
      *
      * const clamp = BigInt.clamp({ minimum: 1n, maximum: 5n })
@@ -671,6 +742,7 @@ export declare const clamp: {
      * assert.equal(clamp(3n), 3n)
      * assert.equal(clamp(0n), 1n)
      * assert.equal(clamp(6n), 5n)
+     * ```
      *
      * @since 2.0.0
      */
@@ -686,9 +758,11 @@ export declare const clamp: {
  * @param that - The second `bigint`.
  *
  * @example
+ * ```ts
  * import { min } from "effect/BigInt"
  *
  * assert.deepStrictEqual(min(2n, 3n), 2n)
+ * ```
  *
  * @since 2.0.0
  */
@@ -700,9 +774,11 @@ export declare const min: {
      * @param that - The second `bigint`.
      *
      * @example
+     * ```ts
      * import { min } from "effect/BigInt"
      *
      * assert.deepStrictEqual(min(2n, 3n), 2n)
+     * ```
      *
      * @since 2.0.0
      */
@@ -714,9 +790,11 @@ export declare const min: {
      * @param that - The second `bigint`.
      *
      * @example
+     * ```ts
      * import { min } from "effect/BigInt"
      *
      * assert.deepStrictEqual(min(2n, 3n), 2n)
+     * ```
      *
      * @since 2.0.0
      */
@@ -729,9 +807,11 @@ export declare const min: {
  * @param that - The second `bigint`.
  *
  * @example
+ * ```ts
  * import { max } from "effect/BigInt"
  *
  * assert.deepStrictEqual(max(2n, 3n), 3n)
+ * ```
  *
  * @since 2.0.0
  */
@@ -743,9 +823,11 @@ export declare const max: {
      * @param that - The second `bigint`.
      *
      * @example
+     * ```ts
      * import { max } from "effect/BigInt"
      *
      * assert.deepStrictEqual(max(2n, 3n), 3n)
+     * ```
      *
      * @since 2.0.0
      */
@@ -757,9 +839,11 @@ export declare const max: {
      * @param that - The second `bigint`.
      *
      * @example
+     * ```ts
      * import { max } from "effect/BigInt"
      *
      * assert.deepStrictEqual(max(2n, 3n), 3n)
+     * ```
      *
      * @since 2.0.0
      */
@@ -771,11 +855,13 @@ export declare const max: {
  * @param n - The `bigint` to determine the sign of.
  *
  * @example
+ * ```ts
  * import { sign } from "effect/BigInt"
  *
  * assert.deepStrictEqual(sign(-5n), -1)
  * assert.deepStrictEqual(sign(0n), 0)
  * assert.deepStrictEqual(sign(5n), 1)
+ * ```
  *
  * @category math
  * @since 2.0.0
@@ -787,11 +873,13 @@ export declare const sign: (n: bigint) => Ordering;
  * @param n - The `bigint` to determine the absolute value of.
  *
  * @example
+ * ```ts
  * import { abs } from "effect/BigInt"
  *
  * assert.deepStrictEqual(abs(-5n), 5n)
  * assert.deepStrictEqual(abs(0n), 0n)
  * assert.deepStrictEqual(abs(5n), 5n)
+ * ```
  *
  * @category math
  * @since 2.0.0
@@ -804,11 +892,13 @@ export declare const abs: (n: bigint) => bigint;
  * @param b - The second `bigint`.
  *
  * @example
+ * ```ts
  * import { gcd } from "effect/BigInt"
  *
  * assert.deepStrictEqual(gcd(2n, 3n), 1n)
  * assert.deepStrictEqual(gcd(2n, 4n), 2n)
  * assert.deepStrictEqual(gcd(16n, 24n), 8n)
+ * ```
  *
  * @category math
  * @since 2.0.0
@@ -821,11 +911,13 @@ export declare const gcd: {
      * @param b - The second `bigint`.
      *
      * @example
+     * ```ts
      * import { gcd } from "effect/BigInt"
      *
      * assert.deepStrictEqual(gcd(2n, 3n), 1n)
      * assert.deepStrictEqual(gcd(2n, 4n), 2n)
      * assert.deepStrictEqual(gcd(16n, 24n), 8n)
+     * ```
      *
      * @category math
      * @since 2.0.0
@@ -838,11 +930,13 @@ export declare const gcd: {
      * @param b - The second `bigint`.
      *
      * @example
+     * ```ts
      * import { gcd } from "effect/BigInt"
      *
      * assert.deepStrictEqual(gcd(2n, 3n), 1n)
      * assert.deepStrictEqual(gcd(2n, 4n), 2n)
      * assert.deepStrictEqual(gcd(16n, 24n), 8n)
+     * ```
      *
      * @category math
      * @since 2.0.0
@@ -856,11 +950,13 @@ export declare const gcd: {
  * @param b - The second `bigint`.
  *
  * @example
+ * ```ts
  * import { lcm } from "effect/BigInt"
  *
  * assert.deepStrictEqual(lcm(2n, 3n), 6n)
  * assert.deepStrictEqual(lcm(2n, 4n), 4n)
  * assert.deepStrictEqual(lcm(16n, 24n), 48n)
+ * ```
  *
  * @category math
  * @since 2.0.0
@@ -873,11 +969,13 @@ export declare const lcm: {
      * @param b - The second `bigint`.
      *
      * @example
+     * ```ts
      * import { lcm } from "effect/BigInt"
      *
      * assert.deepStrictEqual(lcm(2n, 3n), 6n)
      * assert.deepStrictEqual(lcm(2n, 4n), 4n)
      * assert.deepStrictEqual(lcm(16n, 24n), 48n)
+     * ```
      *
      * @category math
      * @since 2.0.0
@@ -890,11 +988,13 @@ export declare const lcm: {
      * @param b - The second `bigint`.
      *
      * @example
+     * ```ts
      * import { lcm } from "effect/BigInt"
      *
      * assert.deepStrictEqual(lcm(2n, 3n), 6n)
      * assert.deepStrictEqual(lcm(2n, 4n), 4n)
      * assert.deepStrictEqual(lcm(16n, 24n), 48n)
+     * ```
      *
      * @category math
      * @since 2.0.0
@@ -907,11 +1007,13 @@ export declare const lcm: {
  * @param n - The `bigint` to determine the square root of.
  *
  * @example
+ * ```ts
  * import { unsafeSqrt } from "effect/BigInt"
  *
  * assert.deepStrictEqual(unsafeSqrt(4n), 2n)
  * assert.deepStrictEqual(unsafeSqrt(9n), 3n)
  * assert.deepStrictEqual(unsafeSqrt(16n), 4n)
+ * ```
  *
  * @category math
  * @since 2.0.0
@@ -923,12 +1025,14 @@ export declare const unsafeSqrt: (n: bigint) => bigint;
  * @param n - The `bigint` to determine the square root of.
  *
  * @example
+ * ```ts
  * import { BigInt, Option } from "effect"
  *
  * assert.deepStrictEqual(BigInt.sqrt(4n), Option.some(2n))
  * assert.deepStrictEqual(BigInt.sqrt(9n), Option.some(3n))
  * assert.deepStrictEqual(BigInt.sqrt(16n), Option.some(4n))
  * assert.deepStrictEqual(BigInt.sqrt(-1n), Option.none())
+ * ```
  *
  * @category math
  * @since 2.0.0
@@ -940,9 +1044,11 @@ export declare const sqrt: (n: bigint) => Option.Option<bigint>;
  * @param collection - The collection of `bigint`s to sum.
  *
  * @example
+ * ```ts
  * import { sumAll } from "effect/BigInt"
  *
  * assert.deepStrictEqual(sumAll([2n, 3n, 4n]), 9n)
+ * ```
  *
  * @category math
  * @since 2.0.0
@@ -954,9 +1060,11 @@ export declare const sumAll: (collection: Iterable<bigint>) => bigint;
  * @param collection - The collection of `bigint`s to multiply.
  *
  * @example
+ * ```ts
  * import { multiplyAll } from "effect/BigInt"
  *
  * assert.deepStrictEqual(multiplyAll([2n, 3n, 4n]), 24n)
+ * ```
  *
  * @category math
  * @since 2.0.0
@@ -972,11 +1080,13 @@ export declare const multiplyAll: (collection: Iterable<bigint>) => bigint;
  * @param b - The `bigint` to be converted to a `number`.
  *
  * @example
+ * ```ts
  * import { BigInt as BI, Option } from "effect"
  *
  * assert.deepStrictEqual(BI.toNumber(BigInt(42)), Option.some(42))
  * assert.deepStrictEqual(BI.toNumber(BigInt(Number.MAX_SAFE_INTEGER) + BigInt(1)), Option.none())
  * assert.deepStrictEqual(BI.toNumber(BigInt(Number.MIN_SAFE_INTEGER) - BigInt(1)), Option.none())
+ * ```
  *
  * @category conversions
  * @since 2.0.0
@@ -991,11 +1101,13 @@ export declare const toNumber: (b: bigint) => Option.Option<number>;
  * @param s - The string to be converted to a `bigint`.
  *
  * @example
+ * ```ts
  * import { BigInt as BI, Option } from "effect"
  *
  * assert.deepStrictEqual(BI.fromString("42"), Option.some(BigInt(42)))
  * assert.deepStrictEqual(BI.fromString(" "), Option.none())
  * assert.deepStrictEqual(BI.fromString("a"), Option.none())
+ * ```
  *
  * @category conversions
  * @since 2.4.12
@@ -1011,11 +1123,13 @@ export declare const fromString: (s: string) => Option.Option<bigint>;
  * @param n - The number to be converted to a `bigint`.
  *
  * @example
+ * ```ts
  * import { BigInt as BI, Option } from "effect"
  *
  * assert.deepStrictEqual(BI.fromNumber(42), Option.some(BigInt(42)))
  * assert.deepStrictEqual(BI.fromNumber(Number.MAX_SAFE_INTEGER + 1), Option.none())
  * assert.deepStrictEqual(BI.fromNumber(Number.MIN_SAFE_INTEGER - 1), Option.none())
+ * ```
  *
  * @category conversions
  * @since 2.4.12