effect 4.0.1 → 4.0.2

package/dist/BigDecimal.d.ts

@@ -5,6 +5,7 @@
  * divide, round, and format decimal values such as money, quantities, and
  * measurements.
  *
+ * @stability stable
  * @since 2.0.0
  */
 import * as Equal from "./Equal.ts";
@@ -34,6 +35,7 @@ declare const TypeId = "~effect/BigDecimal";
  * d.scale // => 2
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -61,6 +63,7 @@ export interface BigDecimal extends Equal.Equal, Pipeable, Inspectable {
  * BigDecimal.isBigDecimal("123.45") // => false
  * ```
  *
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -93,6 +96,7 @@ export declare const isBigDecimal: (u: unknown) => u is BigDecimal;
  *
  * @see {@link fromBigInt} for constructing an integer decimal from a `bigint`
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -119,6 +123,7 @@ export declare const make: (value: bigint, scale: number) => BigDecimal;
  *
  * @see {@link format} for rendering normalized decimals as strings
  *
+ * @stability stable
  * @category scaling
  * @since 2.0.0
  */
@@ -154,6 +159,7 @@ export declare const normalize: (self: BigDecimal) => BigDecimal;
  *
  * @see {@link round} for changing scale with configurable rounding
  *
+ * @stability stable
  * @category scaling
  * @since 2.0.0
  */
@@ -189,6 +195,7 @@ export declare const scale: {
      *
      * @see {@link round} for changing scale with configurable rounding
      *
+     * @stability stable
      * @category scaling
      * @since 2.0.0
      */
@@ -224,6 +231,7 @@ export declare const scale: {
      *
      * @see {@link round} for changing scale with configurable rounding
      *
+     * @stability stable
      * @category scaling
      * @since 2.0.0
      */
@@ -250,6 +258,7 @@ export declare const scale: {
  *
  * @see {@link sumAll} for summing an iterable of `BigDecimal` values
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -275,6 +284,7 @@ export declare const sum: {
      *
      * @see {@link sumAll} for summing an iterable of `BigDecimal` values
      *
+     * @stability stable
      * @category math
      * @since 2.0.0
      */
@@ -300,6 +310,7 @@ export declare const sum: {
      *
      * @see {@link sumAll} for summing an iterable of `BigDecimal` values
      *
+     * @stability stable
      * @category math
      * @since 2.0.0
      */
@@ -327,6 +338,7 @@ export declare const sum: {
  *
  * @see {@link sum} for adding two `BigDecimal` values
  *
+ * @stability stable
  * @category math
  * @since 3.16.0
  */
@@ -351,6 +363,7 @@ export declare const sumAll: (collection: Iterable<BigDecimal>) => BigDecimal;
  *
  * @see {@link multiplyAll} for multiplying an iterable of `BigDecimal` values
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -375,6 +388,7 @@ export declare const multiply: {
      *
      * @see {@link multiplyAll} for multiplying an iterable of `BigDecimal` values
      *
+     * @stability stable
      * @category math
      * @since 2.0.0
      */
@@ -399,6 +413,7 @@ export declare const multiply: {
      *
      * @see {@link multiplyAll} for multiplying an iterable of `BigDecimal` values
      *
+     * @stability stable
      * @category math
      * @since 2.0.0
      */
@@ -425,6 +440,7 @@ export declare const multiply: {
  *
  * @see {@link multiply} for multiplying two `BigDecimal` values
  *
+ * @stability stable
  * @category math
  * @since 4.0.0
  */
@@ -447,6 +463,7 @@ export declare const multiplyAll: (collection: Iterable<BigDecimal>) => BigDecim
  * ) // => BigDecimal.fromBigInt(-1n)
  * ```
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -469,6 +486,7 @@ export declare const subtract: {
      * ) // => BigDecimal.fromBigInt(-1n)
      * ```
      *
+     * @stability stable
      * @category math
      * @since 2.0.0
      */
@@ -491,6 +509,7 @@ export declare const subtract: {
      * ) // => BigDecimal.fromBigInt(-1n)
      * ```
      *
+     * @stability stable
      * @category math
      * @since 2.0.0
      */
@@ -525,6 +544,7 @@ export declare const subtract: {
  * @see {@link divideUnsafe} for division that throws when the divisor is zero
  * @see {@link remainder} for the decimal remainder operation
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -558,6 +578,7 @@ export declare const divide: {
      * @see {@link divideUnsafe} for division that throws when the divisor is zero
      * @see {@link remainder} for the decimal remainder operation
      *
+     * @stability stable
      * @category math
      * @since 2.0.0
      */
@@ -591,6 +612,7 @@ export declare const divide: {
      * @see {@link divideUnsafe} for division that throws when the divisor is zero
      * @see {@link remainder} for the decimal remainder operation
      *
+     * @stability stable
      * @category math
      * @since 2.0.0
      */
@@ -624,6 +646,7 @@ export declare const divide: {
  *
  * @see {@link divide} for division that returns `Option.none` when the divisor is zero
  *
+ * @stability stable
  * @category math
  * @since 4.0.0
  */
@@ -656,6 +679,7 @@ export declare const divideUnsafe: {
      *
      * @see {@link divide} for division that returns `Option.none` when the divisor is zero
      *
+     * @stability stable
      * @category math
      * @since 4.0.0
      */
@@ -688,6 +712,7 @@ export declare const divideUnsafe: {
      *
      * @see {@link divide} for division that returns `Option.none` when the divisor is zero
      *
+     * @stability stable
      * @category math
      * @since 4.0.0
      */
@@ -715,6 +740,7 @@ export declare const divideUnsafe: {
  * BigDecimal.Order(a, c) // => 0
  * ```
  *
+ * @stability stable
  * @category instances
  * @since 2.0.0
  */
@@ -740,6 +766,7 @@ export declare const Order: order.Order<BigDecimal>;
  * BigDecimal.isLessThan(four, three) // => false
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 4.0.0
  */
@@ -765,6 +792,7 @@ export declare const isLessThan: {
      * BigDecimal.isLessThan(four, three) // => false
      * ```
      *
+     * @stability stable
      * @category predicates
      * @since 4.0.0
      */
@@ -790,6 +818,7 @@ export declare const isLessThan: {
      * BigDecimal.isLessThan(four, three) // => false
      * ```
      *
+     * @stability stable
      * @category predicates
      * @since 4.0.0
      */
@@ -816,6 +845,7 @@ export declare const isLessThan: {
  * BigDecimal.isLessThanOrEqualTo(four, three) // => false
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 4.0.0
  */
@@ -841,6 +871,7 @@ export declare const isLessThanOrEqualTo: {
      * BigDecimal.isLessThanOrEqualTo(four, three) // => false
      * ```
      *
+     * @stability stable
      * @category predicates
      * @since 4.0.0
      */
@@ -866,6 +897,7 @@ export declare const isLessThanOrEqualTo: {
      * BigDecimal.isLessThanOrEqualTo(four, three) // => false
      * ```
      *
+     * @stability stable
      * @category predicates
      * @since 4.0.0
      */
@@ -892,6 +924,7 @@ export declare const isLessThanOrEqualTo: {
  * BigDecimal.isGreaterThan(four, three) // => true
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 4.0.0
  */
@@ -917,6 +950,7 @@ export declare const isGreaterThan: {
      * BigDecimal.isGreaterThan(four, three) // => true
      * ```
      *
+     * @stability stable
      * @category predicates
      * @since 4.0.0
      */
@@ -942,6 +976,7 @@ export declare const isGreaterThan: {
      * BigDecimal.isGreaterThan(four, three) // => true
      * ```
      *
+     * @stability stable
      * @category predicates
      * @since 4.0.0
      */
@@ -968,6 +1003,7 @@ export declare const isGreaterThan: {
  * BigDecimal.isGreaterThanOrEqualTo(four, three) // => true
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 4.0.0
  */
@@ -993,6 +1029,7 @@ export declare const isGreaterThanOrEqualTo: {
      * BigDecimal.isGreaterThanOrEqualTo(four, three) // => true
      * ```
      *
+     * @stability stable
      * @category predicates
      * @since 4.0.0
      */
@@ -1018,6 +1055,7 @@ export declare const isGreaterThanOrEqualTo: {
      * BigDecimal.isGreaterThanOrEqualTo(four, three) // => true
      * ```
      *
+     * @stability stable
      * @category predicates
      * @since 4.0.0
      */
@@ -1047,6 +1085,7 @@ export declare const isGreaterThanOrEqualTo: {
  *
  * @see {@link clamp} for forcing a `BigDecimal` into an inclusive range
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -1075,6 +1114,7 @@ export declare const between: {
      *
      * @see {@link clamp} for forcing a `BigDecimal` into an inclusive range
      *
+     * @stability stable
      * @category predicates
      * @since 2.0.0
      */
@@ -1106,6 +1146,7 @@ export declare const between: {
      *
      * @see {@link clamp} for forcing a `BigDecimal` into an inclusive range
      *
+     * @stability stable
      * @category predicates
      * @since 2.0.0
      */
@@ -1144,6 +1185,7 @@ export declare const between: {
  *
  * @see {@link between} for checking whether a `BigDecimal` is already inside a range
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -1178,6 +1220,7 @@ export declare const clamp: {
      *
      * @see {@link between} for checking whether a `BigDecimal` is already inside a range
      *
+     * @stability stable
      * @category math
      * @since 2.0.0
      */
@@ -1215,6 +1258,7 @@ export declare const clamp: {
      *
      * @see {@link between} for checking whether a `BigDecimal` is already inside a range
      *
+     * @stability stable
      * @category math
      * @since 2.0.0
      */
@@ -1243,6 +1287,7 @@ export declare const clamp: {
  *
  * @see {@link max} for selecting the larger value
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -1267,6 +1312,7 @@ export declare const min: {
      *
      * @see {@link max} for selecting the larger value
      *
+     * @stability stable
      * @category math
      * @since 2.0.0
      */
@@ -1291,6 +1337,7 @@ export declare const min: {
      *
      * @see {@link max} for selecting the larger value
      *
+     * @stability stable
      * @category math
      * @since 2.0.0
      */
@@ -1316,6 +1363,7 @@ export declare const min: {
  *
  * @see {@link min} for selecting the smaller value
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -1340,6 +1388,7 @@ export declare const max: {
      *
      * @see {@link min} for selecting the smaller value
      *
+     * @stability stable
      * @category math
      * @since 2.0.0
      */
@@ -1364,6 +1413,7 @@ export declare const max: {
      *
      * @see {@link min} for selecting the smaller value
      *
+     * @stability stable
      * @category math
      * @since 2.0.0
      */
@@ -1386,6 +1436,7 @@ export declare const max: {
  * BigDecimal.sign(BigDecimal.fromStringUnsafe("5")) // => 1
  * ```
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -1407,6 +1458,7 @@ export declare const sign: (n: BigDecimal) => Ordering;
  * BigDecimal.abs(BigDecimal.fromStringUnsafe("5")) // => BigDecimal.fromBigInt(5n)
  * ```
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -1427,6 +1479,7 @@ export declare const abs: (n: BigDecimal) => BigDecimal;
  * BigDecimal.negate(BigDecimal.fromStringUnsafe("-6")) // => BigDecimal.fromBigInt(6n)
  * ```
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -1460,6 +1513,7 @@ export declare const negate: (n: BigDecimal) => BigDecimal;
  * @see {@link remainderUnsafe} for remainder calculation that throws when the divisor is zero
  * @see {@link divide} for decimal quotient calculation
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -1493,6 +1547,7 @@ export declare const remainder: {
      * @see {@link remainderUnsafe} for remainder calculation that throws when the divisor is zero
      * @see {@link divide} for decimal quotient calculation
      *
+     * @stability stable
      * @category math
      * @since 2.0.0
      */
@@ -1526,6 +1581,7 @@ export declare const remainder: {
      * @see {@link remainderUnsafe} for remainder calculation that throws when the divisor is zero
      * @see {@link divide} for decimal quotient calculation
      *
+     * @stability stable
      * @category math
      * @since 2.0.0
      */
@@ -1557,6 +1613,7 @@ export declare const remainder: {
  *
  * @see {@link remainder} for returning `Option.none` when the divisor is zero
  *
+ * @stability stable
  * @category math
  * @since 4.0.0
  */
@@ -1587,6 +1644,7 @@ export declare const remainderUnsafe: {
      *
      * @see {@link remainder} for returning `Option.none` when the divisor is zero
      *
+     * @stability stable
      * @category math
      * @since 4.0.0
      */
@@ -1617,6 +1675,7 @@ export declare const remainderUnsafe: {
      *
      * @see {@link remainder} for returning `Option.none` when the divisor is zero
      *
+     * @stability stable
      * @category math
      * @since 4.0.0
      */
@@ -1643,6 +1702,7 @@ export declare const remainderUnsafe: {
  * BigDecimal.Equivalence(a, c) // => false
  * ```
  *
+ * @stability stable
  * @category instances
  * @since 2.0.0
  */
@@ -1669,6 +1729,7 @@ export declare const Equivalence: Equ.Equivalence<BigDecimal>;
  *
  * @see {@link Equivalence} for passing decimal equality to APIs that require an `Equivalence`
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -1695,6 +1756,7 @@ export declare const equals: {
      *
      * @see {@link Equivalence} for passing decimal equality to APIs that require an `Equivalence`
      *
+     * @stability stable
      * @category predicates
      * @since 2.0.0
      */
@@ -1721,6 +1783,7 @@ export declare const equals: {
      *
      * @see {@link Equivalence} for passing decimal equality to APIs that require an `Equivalence`
      *
+     * @stability stable
      * @category predicates
      * @since 2.0.0
      */
@@ -1747,6 +1810,7 @@ export declare const equals: {
  *
  * @see {@link make} for constructing a decimal with an explicit scale
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -1776,6 +1840,7 @@ export declare const fromBigInt: (n: bigint) => BigDecimal;
  *
  * @see {@link fromNumber} for returning `Option.none` when the number is not finite
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -1809,6 +1874,7 @@ export declare const fromNumberUnsafe: (n: number) => BigDecimal;
  * @see {@link fromNumberUnsafe} for throwing when the number is not finite
  * @see {@link fromString} for parsing decimal strings directly
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -1838,6 +1904,7 @@ export declare const fromNumber: (n: number) => Option.Option<BigDecimal>;
  * @see {@link fromStringUnsafe} for parsing that throws on invalid input
  * @see {@link fromNumber} for converting finite JavaScript numbers
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -1866,6 +1933,7 @@ export declare const fromString: (s: string) => Option.Option<BigDecimal>;
  *
  * @see {@link fromString} for returning `Option.none` on invalid input
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -1895,6 +1963,7 @@ export declare const fromStringUnsafe: (s: string) => BigDecimal;
  *
  * @see {@link toExponential} for always rendering scientific notation
  *
+ * @stability stable
  * @category converting
  * @since 2.0.0
  */
@@ -1916,6 +1985,7 @@ export declare const format: (n: BigDecimal) => string;
  *
  * @see {@link format} for plain decimal formatting when possible
  *
+ * @stability stable
  * @category converting
  * @since 3.11.0
  */
@@ -1944,6 +2014,7 @@ export declare const toExponential: (n: BigDecimal) => string;
  *
  * @see {@link format} for preserving decimal precision as text
  *
+ * @stability stable
  * @category converting
  * @since 4.0.0
  */
@@ -1965,6 +2036,7 @@ export declare const toNumberUnsafe: (n: BigDecimal) => number;
  * BigDecimal.isInteger(BigDecimal.fromStringUnsafe("1.1")) // => false
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -1985,6 +2057,7 @@ export declare const isInteger: (n: BigDecimal) => boolean;
  * BigDecimal.isZero(BigDecimal.fromStringUnsafe("1")) // => false
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -2006,6 +2079,7 @@ export declare const isZero: (n: BigDecimal) => boolean;
  * BigDecimal.isNegative(BigDecimal.fromStringUnsafe("1")) // => false
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -2027,6 +2101,7 @@ export declare const isNegative: (n: BigDecimal) => boolean;
  * BigDecimal.isPositive(BigDecimal.fromStringUnsafe("1")) // => true
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -2057,6 +2132,7 @@ export declare const isPositive: (n: BigDecimal) => boolean;
  * @see {@link floor} for fixed rounding toward negative infinity
  * @see {@link truncate} for fixed rounding toward zero
  *
+ * @stability stable
  * @category math
  * @since 3.16.0
  */
@@ -2084,6 +2160,7 @@ export type RoundingMode = "ceil" | "floor" | "to-zero" | "from-zero" | "half-ce
  * @see {@link floor} for fixed rounding toward negative infinity
  * @see {@link truncate} for fixed rounding toward zero
  *
+ * @stability stable
  * @category math
  * @since 3.16.0
  */
@@ -2111,6 +2188,7 @@ export declare const round: {
      * @see {@link floor} for fixed rounding toward negative infinity
      * @see {@link truncate} for fixed rounding toward zero
      *
+     * @stability stable
      * @category math
      * @since 3.16.0
      */
@@ -2141,6 +2219,7 @@ export declare const round: {
      * @see {@link floor} for fixed rounding toward negative infinity
      * @see {@link truncate} for fixed rounding toward zero
      *
+     * @stability stable
      * @category math
      * @since 3.16.0
      */
@@ -2171,6 +2250,7 @@ export declare const round: {
  * @see {@link ceil} for rounding toward positive infinity
  * @see {@link floor} for rounding toward negative infinity
  *
+ * @stability stable
  * @category math
  * @since 3.16.0
  */
@@ -2197,6 +2277,7 @@ export declare const truncate: {
      * @see {@link ceil} for rounding toward positive infinity
      * @see {@link floor} for rounding toward negative infinity
      *
+     * @stability stable
      * @category math
      * @since 3.16.0
      */
@@ -2223,6 +2304,7 @@ export declare const truncate: {
      * @see {@link ceil} for rounding toward positive infinity
      * @see {@link floor} for rounding toward negative infinity
      *
+     * @stability stable
      * @category math
      * @since 3.16.0
      */
@@ -2254,6 +2336,7 @@ export declare const truncate: {
  * BigDecimal.ceil(BigDecimal.fromStringUnsafe("-14.5")) // => BigDecimal.fromBigInt(-14n)
  * ```
  *
+ * @stability stable
  * @category math
  * @since 3.16.0
  */
@@ -2284,6 +2367,7 @@ export declare const ceil: {
      * BigDecimal.ceil(BigDecimal.fromStringUnsafe("-14.5")) // => BigDecimal.fromBigInt(-14n)
      * ```
      *
+     * @stability stable
      * @category math
      * @since 3.16.0
      */
@@ -2314,6 +2398,7 @@ export declare const ceil: {
      * BigDecimal.ceil(BigDecimal.fromStringUnsafe("-14.5")) // => BigDecimal.fromBigInt(-14n)
      * ```
      *
+     * @stability stable
      * @category math
      * @since 3.16.0
      */
@@ -2339,6 +2424,7 @@ export declare const ceil: {
  * @see {@link truncate} for rounding toward zero
  * @see {@link round} for configurable rounding modes
  *
+ * @stability stable
  * @category math
  * @since 3.16.0
  */
@@ -2363,6 +2449,7 @@ export declare const floor: {
      * @see {@link truncate} for rounding toward zero
      * @see {@link round} for configurable rounding modes
      *
+     * @stability stable
      * @category math
      * @since 3.16.0
      */
@@ -2387,6 +2474,7 @@ export declare const floor: {
      * @see {@link truncate} for rounding toward zero
      * @see {@link round} for configurable rounding modes
      *
+     * @stability stable
      * @category math
      * @since 3.16.0
      */