effect 4.0.0 → 4.0.2

package/src/Number.ts

@@ -5,6 +5,7 @@
  * checking, parsing, arithmetic, safe division, comparison, range checks,
  * clamping, rounding, ordering, equivalence, and numeric aggregation.
  *
+ * @stability stable
  * @since 2.0.0
  */
 import * as Equ from "./Equivalence.ts"
@@ -39,6 +40,7 @@ import * as Reducer from "./Reducer.ts"
  * N.Number("3.14") // => 3.14
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -60,6 +62,7 @@ export const Number = globalThis.Number
  * Number.isNumber("2") // => false
  * ```
  *
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -82,6 +85,7 @@ export const isNumber: (input: unknown) => input is number = predicate.isNumber
  *
  * @see {@link sumAll} for summing an iterable of numbers
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -103,6 +107,7 @@ export const sum: {
    *
    * @see {@link sumAll} for summing an iterable of numbers
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -124,6 +129,7 @@ export const sum: {
    *
    * @see {@link sumAll} for summing an iterable of numbers
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -147,6 +153,7 @@ export const sum: {
  *
  * @see {@link multiplyAll} for multiplying an iterable of numbers
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -168,6 +175,7 @@ export const multiply: {
    *
    * @see {@link multiplyAll} for multiplying an iterable of numbers
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -189,6 +197,7 @@ export const multiply: {
    *
    * @see {@link multiplyAll} for multiplying an iterable of numbers
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -210,6 +219,7 @@ export const multiply: {
  * Number.subtract(2, 3) // => -1
  * ```
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -229,6 +239,7 @@ export const subtract: {
    * Number.subtract(2, 3) // => -1
    * ```
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -248,6 +259,7 @@ export const subtract: {
    * Number.subtract(2, 3) // => -1
    * ```
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -273,6 +285,7 @@ export const subtract: {
  * @see {@link divideUnsafe} for division that throws when the divisor is zero
  * @see {@link remainder} for the numeric remainder operation
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -296,6 +309,7 @@ export const divide: {
    * @see {@link divideUnsafe} for division that throws when the divisor is zero
    * @see {@link remainder} for the numeric remainder operation
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -319,6 +333,7 @@ export const divide: {
    * @see {@link divideUnsafe} for division that throws when the divisor is zero
    * @see {@link remainder} for the numeric remainder operation
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -356,6 +371,7 @@ export const divide: {
  *
  * @see {@link divide} for division that returns `Option.none` when the divisor is zero
  *
+ * @stability stable
  * @category math
  * @since 4.0.0
  */
@@ -388,6 +404,7 @@ export const divideUnsafe: {
    *
    * @see {@link divide} for division that returns `Option.none` when the divisor is zero
    *
+   * @stability stable
    * @category math
    * @since 4.0.0
    */
@@ -420,6 +437,7 @@ export const divideUnsafe: {
    *
    * @see {@link divide} for division that returns `Option.none` when the divisor is zero
    *
+   * @stability stable
    * @category math
    * @since 4.0.0
    */
@@ -445,6 +463,7 @@ export const divideUnsafe: {
  * Number.increment(2) // => 3
  * ```
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -465,6 +484,7 @@ export const increment = (n: number): number => n + 1
  * Number.decrement(3) // => 2
  * ```
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -488,6 +508,7 @@ export const decrement = (n: number): number => n - 1
  * Number.Order(1, 1) // => 0
  * ```
  *
+ * @stability stable
  * @category instances
  * @since 2.0.0
  */
@@ -511,6 +532,7 @@ export const Order: order.Order<number> = order.Number
  * Number.Equivalence(NaN, NaN) // => true
  * ```
  *
+ * @stability stable
  * @category instances
  * @since 2.0.0
  */
@@ -533,6 +555,7 @@ export const Equivalence: Equ.Equivalence<number> = Equ.Number
  * Number.isLessThan(4, 3) // => false
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 4.0.0
  */
@@ -554,6 +577,7 @@ export const isLessThan: {
    * Number.isLessThan(4, 3) // => false
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 4.0.0
    */
@@ -575,6 +599,7 @@ export const isLessThan: {
    * Number.isLessThan(4, 3) // => false
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 4.0.0
    */
@@ -598,6 +623,7 @@ export const isLessThan: {
  * Number.isLessThanOrEqualTo(4, 3) // => false
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 4.0.0
  */
@@ -619,6 +645,7 @@ export const isLessThanOrEqualTo: {
    * Number.isLessThanOrEqualTo(4, 3) // => false
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 4.0.0
    */
@@ -640,6 +667,7 @@ export const isLessThanOrEqualTo: {
    * Number.isLessThanOrEqualTo(4, 3) // => false
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 4.0.0
    */
@@ -663,6 +691,7 @@ export const isLessThanOrEqualTo: {
  * Number.isGreaterThan(4, 3) // => true
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 4.0.0
  */
@@ -684,6 +713,7 @@ export const isGreaterThan: {
    * Number.isGreaterThan(4, 3) // => true
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 4.0.0
    */
@@ -705,6 +735,7 @@ export const isGreaterThan: {
    * Number.isGreaterThan(4, 3) // => true
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 4.0.0
    */
@@ -728,6 +759,7 @@ export const isGreaterThan: {
  * Number.isGreaterThanOrEqualTo(4, 3) // => true
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 4.0.0
  */
@@ -749,6 +781,7 @@ export const isGreaterThanOrEqualTo: {
    * Number.isGreaterThanOrEqualTo(4, 3) // => true
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 4.0.0
    */
@@ -770,6 +803,7 @@ export const isGreaterThanOrEqualTo: {
    * Number.isGreaterThanOrEqualTo(4, 3) // => true
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 4.0.0
    */
@@ -797,6 +831,7 @@ export const isGreaterThanOrEqualTo: {
  *
  * @see {@link clamp} for forcing a number into an inclusive range
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -822,6 +857,7 @@ export const between: {
    *
    * @see {@link clamp} for forcing a number into an inclusive range
    *
+   * @stability stable
    * @category predicates
    * @since 2.0.0
    */
@@ -852,6 +888,7 @@ export const between: {
    *
    * @see {@link clamp} for forcing a number into an inclusive range
    *
+   * @stability stable
    * @category predicates
    * @since 2.0.0
    */
@@ -893,6 +930,7 @@ export const between: {
  *
  * @see {@link between} for checking whether a number is already inside a range
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -926,6 +964,7 @@ export const clamp: {
    *
    * @see {@link between} for checking whether a number is already inside a range
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -964,6 +1003,7 @@ export const clamp: {
    *
    * @see {@link between} for checking whether a number is already inside a range
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -993,6 +1033,7 @@ export const clamp: {
  *
  * @see {@link max} for selecting the larger value
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -1014,6 +1055,7 @@ export const min: {
    *
    * @see {@link max} for selecting the larger value
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -1035,6 +1077,7 @@ export const min: {
    *
    * @see {@link max} for selecting the larger value
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -1058,6 +1101,7 @@ export const min: {
  *
  * @see {@link min} for selecting the smaller value
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -1079,6 +1123,7 @@ export const max: {
    *
    * @see {@link min} for selecting the smaller value
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -1100,6 +1145,7 @@ export const max: {
    *
    * @see {@link min} for selecting the smaller value
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -1123,6 +1169,7 @@ export const max: {
  * Number.sign(5) // => 1
  * ```
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -1146,6 +1193,7 @@ export const sign = (n: number): Ordering => Order(n, 0)
  * @see {@link sum} for adding two numbers
  * @see {@link ReducerSum} for summing through APIs that consume a `Reducer`
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -1175,6 +1223,7 @@ export const sumAll = (collection: Iterable<number>): number => {
  * @see {@link multiply} for multiplying two numbers
  * @see {@link ReducerMultiply} for multiplying through APIs that consume a `Reducer`
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -1209,6 +1258,7 @@ export const multiplyAll = (collection: Iterable<number>): number => {
  *
  * @see {@link divide} for quotient calculation with division-by-zero represented as `Option.none`
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -1233,6 +1283,7 @@ export const remainder: {
    *
    * @see {@link divide} for quotient calculation with division-by-zero represented as `Option.none`
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -1257,6 +1308,7 @@ export const remainder: {
    *
    * @see {@link divide} for quotient calculation with division-by-zero represented as `Option.none`
    *
+   * @stability stable
    * @category math
    * @since 2.0.0
    */
@@ -1309,6 +1361,7 @@ function toScientificInteger(n: number): readonly [coefficient: bigint, exponent
  * Number.nextPow2(17) // => 32
  * ```
  *
+ * @stability stable
  * @category math
  * @since 2.0.0
  */
@@ -1340,6 +1393,7 @@ export const nextPow2 = (n: number): number => {
  *
  * @see {@link Number} for native constructor coercion
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -1376,6 +1430,7 @@ export const parse = (s: string): Option.Option<number> => {
  * Number.round(1.567, 2) // => 1.57
  * ```
  *
+ * @stability stable
  * @category math
  * @since 3.8.0
  */
@@ -1396,6 +1451,7 @@ export const round: {
    * Number.round(1.567, 2) // => 1.57
    * ```
    *
+   * @stability stable
    * @category math
    * @since 3.8.0
    */
@@ -1416,6 +1472,7 @@ export const round: {
    * Number.round(1.567, 2) // => 1.57
    * ```
    *
+   * @stability stable
    * @category math
    * @since 3.8.0
    */
@@ -1439,6 +1496,7 @@ export const round: {
  * @see {@link sumAll} for summing an iterable directly
  * @see {@link ReducerMultiply} for multiplying number values
  *
+ * @stability stable
  * @category math
  * @since 4.0.0
  */
@@ -1462,6 +1520,7 @@ export const ReducerSum: Reducer.Reducer<number> = Reducer.make((a, b) => a + b,
  *
  * @see {@link multiplyAll} for multiplying an iterable directly
  *
+ * @stability stable
  * @category math
  * @since 4.0.0
  */
@@ -1493,6 +1552,7 @@ export const ReducerMultiply: Reducer.Reducer<number> = Reducer.make((a, b) => a
  * @see {@link ReducerMin} for keeping the smallest number
  * @see {@link max} for comparing two numbers directly
  *
+ * @stability stable
  * @category math
  * @since 4.0.0
  */
@@ -1517,6 +1577,7 @@ export const ReducerMax: Reducer.Reducer<number> = Reducer.make((a, b) => Math.m
  * @see {@link ReducerMax} for keeping the largest number
  * @see {@link min} for comparing two numbers directly
  *
+ * @stability stable
  * @category math
  * @since 4.0.0
  */