effect 4.0.0 → 4.0.2

package/src/BigInt.ts

@@ -6,6 +6,7 @@
  * that return `Option`, integer square roots, aggregation, ordering,
  * equivalence, reducers, and combiners.
  *
+ * @stability stable
  * @since 2.0.0
  */
 
@@ -43,6 +44,7 @@ import * as Reducer from "./Reducer.ts"
  * BigInt.BigInt("456") // => 456n
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -68,6 +70,7 @@ const bigint2 = BigInt(2)
  * BigInt.isBigInt(1) // => false
  * ```
  *
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -91,6 +94,7 @@ export const isBigInt: (u: unknown) => u is bigint = predicate.isBigInt
  *
  * @see {@link sumAll} for summing an iterable of `bigint` values
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -113,6 +117,7 @@ export const sum: {
    *
    * @see {@link sumAll} for summing an iterable of `bigint` values
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -135,6 +140,7 @@ export const sum: {
    *
    * @see {@link sumAll} for summing an iterable of `bigint` values
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -158,6 +164,7 @@ export const sum: {
  *
  * @see {@link multiplyAll} for multiplying an iterable of `bigint` values
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -179,6 +186,7 @@ export const multiply: {
    *
    * @see {@link multiplyAll} for multiplying an iterable of `bigint` values
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -200,6 +208,7 @@ export const multiply: {
    *
    * @see {@link multiplyAll} for multiplying an iterable of `bigint` values
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -221,6 +230,7 @@ export const multiply: {
  * BigInt.subtract(2n, 3n) // => -1n
  * ```
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -240,6 +250,7 @@ export const subtract: {
    * BigInt.subtract(2n, 3n) // => -1n
    * ```
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -259,6 +270,7 @@ export const subtract: {
    * BigInt.subtract(2n, 3n) // => -1n
    * ```
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -290,6 +302,7 @@ export const subtract: {
  * @see {@link divideUnsafe} for division that throws when the divisor is `0n`
  * @see {@link remainder} for the JavaScript remainder operation
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -319,6 +332,7 @@ export const divide: {
    * @see {@link divideUnsafe} for division that throws when the divisor is `0n`
    * @see {@link remainder} for the JavaScript remainder operation
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -348,6 +362,7 @@ export const divide: {
    * @see {@link divideUnsafe} for division that throws when the divisor is `0n`
    * @see {@link remainder} for the JavaScript remainder operation
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -385,6 +400,7 @@ export const divide: {
  *
  * @see {@link divide} for division that returns `Option.none` when the divisor is `0n`
  *
+ * @stability stable
  * @category math
  * @since 4.0.0
  */
@@ -417,6 +433,7 @@ export const divideUnsafe: {
    *
    * @see {@link divide} for division that returns `Option.none` when the divisor is `0n`
    *
+   * @stability stable
    * @category math
    * @since 4.0.0
    */
@@ -449,6 +466,7 @@ export const divideUnsafe: {
    *
    * @see {@link divide} for division that returns `Option.none` when the divisor is `0n`
    *
+   * @stability stable
    * @category math
    * @since 4.0.0
    */
@@ -470,6 +488,7 @@ export const divideUnsafe: {
  * BigInt.increment(2n) // => 3n
  * ```
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -490,6 +509,7 @@ export const increment = (n: bigint): bigint => n + bigint1
  * BigInt.decrement(3n) // => 2n
  * ```
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -517,6 +537,7 @@ export const decrement = (n: bigint): bigint => n - bigint1
  * BigInt.Order(a, c) // => 0
  * ```
  *
+ * @stability stable
  * @category instances
  * @since 2.0.0
  */
@@ -539,6 +560,7 @@ export const Order: order.Order<bigint> = order.BigInt
  * BigInt.Equivalence(1n, 2n) // => false
  * ```
  *
+ * @stability stable
  * @category instances
  * @since 2.0.0
  */
@@ -561,6 +583,7 @@ export const Equivalence: Equ.Equivalence<bigint> = Equ.BigInt
  * BigInt.isLessThan(4n, 3n) // => false
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 4.0.0
  */
@@ -582,6 +605,7 @@ export const isLessThan: {
    * BigInt.isLessThan(4n, 3n) // => false
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 4.0.0
    */
@@ -603,6 +627,7 @@ export const isLessThan: {
    * BigInt.isLessThan(4n, 3n) // => false
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 4.0.0
    */
@@ -626,6 +651,7 @@ export const isLessThan: {
  * BigInt.isLessThanOrEqualTo(4n, 3n) // => false
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 4.0.0
  */
@@ -647,6 +673,7 @@ export const isLessThanOrEqualTo: {
    * BigInt.isLessThanOrEqualTo(4n, 3n) // => false
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 4.0.0
    */
@@ -668,6 +695,7 @@ export const isLessThanOrEqualTo: {
    * BigInt.isLessThanOrEqualTo(4n, 3n) // => false
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 4.0.0
    */
@@ -691,6 +719,7 @@ export const isLessThanOrEqualTo: {
  * BigInt.isGreaterThan(4n, 3n) // => true
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 4.0.0
  */
@@ -712,6 +741,7 @@ export const isGreaterThan: {
    * BigInt.isGreaterThan(4n, 3n) // => true
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 4.0.0
    */
@@ -733,6 +763,7 @@ export const isGreaterThan: {
    * BigInt.isGreaterThan(4n, 3n) // => true
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 4.0.0
    */
@@ -756,6 +787,7 @@ export const isGreaterThan: {
  * BigInt.isGreaterThanOrEqualTo(4n, 3n) // => true
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 4.0.0
  */
@@ -777,6 +809,7 @@ export const isGreaterThanOrEqualTo: {
    * BigInt.isGreaterThanOrEqualTo(4n, 3n) // => true
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 4.0.0
    */
@@ -798,6 +831,7 @@ export const isGreaterThanOrEqualTo: {
    * BigInt.isGreaterThanOrEqualTo(4n, 3n) // => true
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 4.0.0
    */
@@ -825,6 +859,7 @@ export const isGreaterThanOrEqualTo: {
  *
  * @see {@link clamp} for forcing a `bigint` into an inclusive range
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -850,6 +885,7 @@ export const between: {
    *
    * @see {@link clamp} for forcing a `bigint` into an inclusive range
    *
+   * @stability stable
    * @category predicates
    * @since 2.0.0
    */
@@ -880,6 +916,7 @@ export const between: {
    *
    * @see {@link clamp} for forcing a `bigint` into an inclusive range
    *
+   * @stability stable
    * @category predicates
    * @since 2.0.0
    */
@@ -919,6 +956,7 @@ export const between: {
  *
  * @see {@link between} for checking whether a `bigint` is already inside a range
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -950,6 +988,7 @@ export const clamp: {
    *
    * @see {@link between} for checking whether a `bigint` is already inside a range
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -986,6 +1025,7 @@ export const clamp: {
    *
    * @see {@link between} for checking whether a `bigint` is already inside a range
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -1015,6 +1055,7 @@ export const clamp: {
  *
  * @see {@link max} for selecting the larger value
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -1036,6 +1077,7 @@ export const min: {
    *
    * @see {@link max} for selecting the larger value
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -1057,6 +1099,7 @@ export const min: {
    *
    * @see {@link max} for selecting the larger value
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -1080,6 +1123,7 @@ export const min: {
  *
  * @see {@link min} for selecting the smaller value
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -1101,6 +1145,7 @@ export const max: {
    *
    * @see {@link min} for selecting the smaller value
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -1122,6 +1167,7 @@ export const max: {
    *
    * @see {@link min} for selecting the smaller value
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -1145,6 +1191,7 @@ export const max: {
  * BigInt.sign(5n) // => 1
  * ```
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -1167,6 +1214,7 @@ export const sign = (n: bigint): Ordering => order.BigInt(n, bigint0)
  * BigInt.abs(5n) // => 5n
  * ```
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -1191,6 +1239,7 @@ export const abs = (n: bigint): bigint => (n < bigint0 ? -n : n)
  *
  * @see {@link lcm} for computing the least common multiple
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -1214,6 +1263,7 @@ export const gcd: {
    *
    * @see {@link lcm} for computing the least common multiple
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -1237,6 +1287,7 @@ export const gcd: {
    *
    * @see {@link lcm} for computing the least common multiple
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -1269,6 +1320,7 @@ export const gcd: {
  *
  * @see {@link gcd} for computing the greatest common divisor
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -1292,6 +1344,7 @@ export const lcm: {
    *
    * @see {@link gcd} for computing the greatest common divisor
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -1315,6 +1368,7 @@ export const lcm: {
    *
    * @see {@link gcd} for computing the greatest common divisor
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -1355,6 +1409,7 @@ export const lcm: {
  *
  * @see {@link sqrt} for returning `Option.none` when the input is negative
  *
+ * @stability stable
  * @category math
  * @since 4.0.0
  */
@@ -1399,6 +1454,7 @@ export const sqrtUnsafe = (n: bigint): bigint => {
  *
  * @see {@link sqrtUnsafe} for square root computation that throws on negative input
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -1424,6 +1480,7 @@ export const sqrt = (n: bigint): Option.Option<bigint> =>
  * @see {@link sum} for adding two `bigint` values
  * @see {@link ReducerSum} for summing through APIs that consume a `Reducer`
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -1453,6 +1510,7 @@ export const sumAll = (collection: Iterable<bigint>): bigint => {
  * @see {@link multiply} for multiplying two `bigint` values
  * @see {@link ReducerMultiply} for multiplying through APIs that consume a `Reducer`
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -1492,6 +1550,7 @@ export const multiplyAll = (collection: Iterable<bigint>): bigint => {
  *
  * @see {@link fromNumber} for converting a safe integer number to `bigint`
  *
+ * @stability stable
  * @category converting
  * @since 2.0.0
  */
@@ -1526,6 +1585,7 @@ export const toNumber = (b: bigint): Option.Option<number> => {
  *
  * @see {@link BigInt} for native constructor coercion that throws on invalid input
  *
+ * @stability stable
  * @category converting
  * @since 2.4.12
  */
@@ -1565,6 +1625,7 @@ export const fromString = (s: string): Option.Option<bigint> => {
  * @see {@link toNumber} for converting `bigint` values back to safe integer numbers
  * @see {@link BigInt} for native constructor coercion
  *
+ * @stability stable
  * @category converting
  * @since 2.4.12
  */
@@ -1603,6 +1664,7 @@ export function fromNumber(n: number): Option.Option<bigint> {
  *
  * @see {@link divide} for quotient calculation with division-by-zero represented as `Option.none`
  *
+ * @stability stable
  * @category math
  * @since 4.0.0
  */
@@ -1630,6 +1692,7 @@ export const remainder: {
    *
    * @see {@link divide} for quotient calculation with division-by-zero represented as `Option.none`
    *
+   * @stability stable
    * @category math
    * @since 4.0.0
    */
@@ -1657,6 +1720,7 @@ export const remainder: {
    *
    * @see {@link divide} for quotient calculation with division-by-zero represented as `Option.none`
    *
+   * @stability stable
    * @category math
    * @since 4.0.0
    */
@@ -1677,6 +1741,7 @@ export const remainder: {
  * @see {@link sumAll} for summing an iterable directly
  * @see {@link ReducerMultiply} for multiplying `bigint` values
  *
+ * @stability stable
  * @category math
  * @since 4.0.0
  */
@@ -1696,6 +1761,7 @@ export const ReducerSum: Reducer.Reducer<bigint> = Reducer.make((a, b) => a + b,
  * @see {@link multiplyAll} for multiplying an iterable directly
  * @see {@link ReducerSum} for summing `bigint` values
  *
+ * @stability stable
  * @category math
  * @since 4.0.0
  */
@@ -1718,6 +1784,7 @@ export const ReducerMultiply: Reducer.Reducer<bigint> = Reducer.make((a, b) => a
  * @see {@link CombinerMin} for keeping the smallest `bigint`
  * @see {@link max} for comparing two `bigint` values directly
  *
+ * @stability stable
  * @category math
  * @since 4.0.0
  */
@@ -1733,6 +1800,7 @@ export const CombinerMax: Combiner.Combiner<bigint> = Combiner.max(Order)
  * @see {@link CombinerMax} for keeping the largest `bigint`
  * @see {@link min} for comparing two `bigint` values directly
  *
+ * @stability stable
  * @category math
  * @since 4.0.0
  */