effect 2.0.0-next.5 → 2.0.0-next.50

package/BigInt/dist/effect-BigInt.cjs.d.mts

@@ -0,0 +1,2 @@
+export * from "../../dist/declarations/src/BigInt.js";
+//# sourceMappingURL=effect-BigInt.cjs.d.mts.map

package/BigInt/dist/effect-BigInt.cjs.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"effect-BigInt.cjs.d.mts","sourceRoot":"","sources":["../../dist/declarations/src/BigInt.d.ts"],"names":[],"mappings":"AAAA"}

package/BigInt/dist/effect-BigInt.cjs.d.ts

@@ -0,0 +1,2 @@
+export * from "../../dist/declarations/src/BigInt";
+//# sourceMappingURL=effect-BigInt.cjs.d.ts.map

package/BigInt/dist/effect-BigInt.cjs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"effect-BigInt.cjs.d.ts","sourceRoot":"","sources":["../../dist/declarations/src/BigInt.d.ts"],"names":[],"mappings":"AAAA"}

package/BigInt/dist/effect-BigInt.cjs.dev.js

@@ -0,0 +1,520 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var Equivalence_dist_effectEquivalence = require('../../Equivalence/dist/effect-Equivalence.cjs.dev.js');
+var Function_dist_effectFunction = require('../../Function/dist/effect-Function.cjs.dev.js');
+var Option_dist_effectOption = require('../../Option/dist/effect-Option.cjs.dev.js');
+var Order_dist_effectOrder = require('../../Order/dist/effect-Order.cjs.dev.js');
+var Predicate_dist_effectPredicate = require('../../Predicate/dist/effect-Predicate.cjs.dev.js');
+require('../../Equal/dist/effect-Equal.cjs.dev.js');
+require('../../Hash/dist/effect-Hash.cjs.dev.js');
+require('../../GlobalValue/dist/effect-GlobalValue.cjs.dev.js');
+require('../../Utils/dist/effect-Utils.cjs.dev.js');
+require('../../dist/Either-e7500e90.cjs.dev.js');
+require('../../Inspectable/dist/effect-Inspectable.cjs.dev.js');
+require('../../dist/Option-01caa9d4.cjs.dev.js');
+require('../../dist/Effectable-71c10ab9.cjs.dev.js');
+require('../../Pipeable/dist/effect-Pipeable.cjs.dev.js');
+
+/**
+ * This module provides utility functions and type class instances for working with the `bigint` type in TypeScript.
+ * It includes functions for basic arithmetic operations, as well as type class instances for
+ * `Equivalence` and `Order`.
+ *
+ * @since 2.0.0
+ */
+const bigint0 = /*#__PURE__*/BigInt(0);
+const bigint1 = /*#__PURE__*/BigInt(1);
+const bigint2 = /*#__PURE__*/BigInt(2);
+
+/**
+ * Tests if a value is a `bigint`.
+ *
+ * @param input - The value to test.
+ *
+ * @example
+ * import { isBigInt } from "effect/BigInt"
+ *
+ * assert.deepStrictEqual(isBigInt(1n), true)
+ * assert.deepStrictEqual(isBigInt(1), false)
+ *
+ * @category guards
+ * @since 2.0.0
+ */
+const isBigInt = Predicate_dist_effectPredicate.isBigInt;
+
+/**
+ * Provides an addition operation on `bigint`s.
+ *
+ * @param self - The first operand.
+ * @param that - The second operand.
+ *
+ * @example
+ * import { sum } from 'effect/BigInt'
+ *
+ * assert.deepStrictEqual(sum(2n, 3n), 5n)
+ *
+ * @category math
+ * @since 2.0.0
+ */
+const sum = /*#__PURE__*/Function_dist_effectFunction.dual(2, (self, that) => self + that);
+
+/**
+ * Provides a multiplication operation on `bigint`s.
+ *
+ * @param self - The first operand.
+ * @param that - The second operand.
+ *
+ * @example
+ * import { multiply } from 'effect/BigInt'
+ *
+ * assert.deepStrictEqual(multiply(2n, 3n), 6n)
+ *
+ * @category math
+ * @since 2.0.0
+ */
+const multiply = /*#__PURE__*/Function_dist_effectFunction.dual(2, (self, that) => self * that);
+
+/**
+ * Provides a subtraction operation on `bigint`s.
+ *
+ * @param self - The first operand.
+ * @param that - The second operand.
+ *
+ * @example
+ * import { subtract } from 'effect/BigInt'
+ *
+ * assert.deepStrictEqual(subtract(2n, 3n), -1n)
+ *
+ * @category math
+ * @since 2.0.0
+ */
+const subtract = /*#__PURE__*/Function_dist_effectFunction.dual(2, (self, that) => self - that);
+
+/**
+ * Provides a division operation on `bigint`s.
+ *
+ * If the dividend is not a multiple of the divisor the result will be a `bigint` value
+ * which represents the integer division rounded down to the nearest integer.
+ *
+ * Returns `None` if the divisor is `0n`.
+ *
+ * @param self - The dividend operand.
+ * @param that - The divisor operand.
+ *
+ * @example
+ * import { divide } from 'effect/BigInt'
+ * import { some, none } from 'effect/Option'
+ *
+ * assert.deepStrictEqual(divide(6n, 3n), some(2n))
+ * assert.deepStrictEqual(divide(6n, 0n), none())
+ *
+ * @category math
+ * @since 2.0.0
+ */
+const divide = /*#__PURE__*/Function_dist_effectFunction.dual(2, (self, that) => that === bigint0 ? Option_dist_effectOption.none() : Option_dist_effectOption.some(self / that));
+
+/**
+ * Provides a division operation on `bigint`s.
+ *
+ * If the dividend is not a multiple of the divisor the result will be a `bigint` value
+ * which represents the integer division rounded down to the nearest integer.
+ *
+ * Throws a `RangeError` if the divisor is `0n`.
+ *
+ * @param self - The dividend operand.
+ * @param that - The divisor operand.
+ *
+ * @example
+ * import { unsafeDivide } from 'effect/BigInt'
+ *
+ * assert.deepStrictEqual(unsafeDivide(6n, 3n), 2n)
+ * assert.deepStrictEqual(unsafeDivide(6n, 4n), 1n)
+ *
+ * @category math
+ * @since 2.0.0
+ */
+const unsafeDivide = /*#__PURE__*/Function_dist_effectFunction.dual(2, (self, that) => self / that);
+
+/**
+ * Returns the result of adding `1n` to a given number.
+ *
+ * @param n - A `bigint` to be incremented.
+ *
+ * @example
+ * import { increment } from 'effect/BigInt'
+ *
+ * assert.deepStrictEqual(increment(2n), 3n)
+ *
+ * @category math
+ * @since 2.0.0
+ */
+const increment = n => n + bigint1;
+
+/**
+ * Decrements a number by `1n`.
+ *
+ * @param n - A `bigint` to be decremented.
+ *
+ * @example
+ * import { decrement } from 'effect/BigInt'
+ *
+ * assert.deepStrictEqual(decrement(3n), 2n)
+ *
+ * @category math
+ * @since 2.0.0
+ */
+const decrement = n => n - bigint1;
+
+/**
+ * @category instances
+ * @since 2.0.0
+ */
+const Equivalence = Equivalence_dist_effectEquivalence.bigint;
+
+/**
+ * @category instances
+ * @since 2.0.0
+ */
+const Order = Order_dist_effectOrder.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
+ * 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
+ */
+const lessThan = /*#__PURE__*/Order_dist_effectOrder.lessThan(Order);
+
+/**
+ * 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
+ * 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
+ */
+const lessThanOrEqualTo = /*#__PURE__*/Order_dist_effectOrder.lessThanOrEqualTo(Order);
+
+/**
+ * Returns `true` if the first argument is greater than the second, otherwise `false`.
+ *
+ * @param self - The first argument.
+ * @param that - The second argument.
+ *
+ * @example
+ * 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
+ */
+const greaterThan = /*#__PURE__*/Order_dist_effectOrder.greaterThan(Order);
+
+/**
+ * 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
+ * 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
+ */
+const greaterThanOrEqualTo = /*#__PURE__*/Order_dist_effectOrder.greaterThanOrEqualTo(Order);
+
+/**
+ * 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
+ * import { between } from 'effect/BigInt'
+ *
+ * assert.deepStrictEqual(between(0n, 5n)(3n), true)
+ * assert.deepStrictEqual(between(0n, 5n)(-1n), false)
+ * assert.deepStrictEqual(between(0n, 5n)(6n), false)
+ *
+ * @category predicates
+ * @since 2.0.0
+ */
+const between = /*#__PURE__*/Order_dist_effectOrder.between(Order);
+
+/**
+ * Restricts the given `bigint` to be within the range specified by the `minimum` and `maximum` values.
+ *
+ * - If the `bigint` is less than the `minimum` value, the function returns the `minimum` value.
+ * - 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
+ * import { clamp } from 'effect/BigInt'
+ *
+ * assert.deepStrictEqual(clamp(0n, 5n)(3n), 3n)
+ * assert.deepStrictEqual(clamp(0n, 5n)(-1n), 0n)
+ * assert.deepStrictEqual(clamp(0n, 5n)(6n), 5n)
+ *
+ * @since 2.0.0
+ */
+const clamp = /*#__PURE__*/Order_dist_effectOrder.clamp(Order);
+
+/**
+ * Returns the minimum between two `bigint`s.
+ *
+ * @param self - The first `bigint`.
+ * @param that - The second `bigint`.
+ *
+ * @example
+ * import { min } from 'effect/BigInt'
+ *
+ * assert.deepStrictEqual(min(2n, 3n), 2n)
+ *
+ * @since 2.0.0
+ */
+const min = /*#__PURE__*/Order_dist_effectOrder.min(Order);
+
+/**
+ * Returns the maximum between two `bigint`s.
+ *
+ * @param self - The first `bigint`.
+ * @param that - The second `bigint`.
+ *
+ * @example
+ * import { max } from 'effect/BigInt'
+ *
+ * assert.deepStrictEqual(max(2n, 3n), 3n)
+ *
+ * @since 2.0.0
+ */
+const max = /*#__PURE__*/Order_dist_effectOrder.max(Order);
+
+/**
+ * Determines the sign of a given `bigint`.
+ *
+ * @param n - The `bigint` to determine the sign of.
+ *
+ * @example
+ * 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
+ */
+const sign = n => Order(n, bigint0);
+
+/**
+ * Determines the absolute value of a given `bigint`.
+ *
+ * @param n - The `bigint` to determine the absolute value of.
+ *
+ * @example
+ * 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
+ */
+const abs = n => n < bigint0 ? -n : n;
+
+/**
+ * Determines the greatest common divisor of two `bigint`s.
+ *
+ * @param a - The first `bigint`.
+ * @param b - The second `bigint`.
+ *
+ * @example
+ * 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
+ */
+const gcd = /*#__PURE__*/Function_dist_effectFunction.dual(2, (self, that) => {
+  while (that !== bigint0) {
+    const t = that;
+    that = self % that;
+    self = t;
+  }
+  return self;
+});
+
+/**
+ * Determines the least common multiple of two `bigint`s.
+ *
+ * @param a - The first `bigint`.
+ * @param b - The second `bigint`.
+ *
+ * @example
+ * 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
+ */
+const lcm = /*#__PURE__*/Function_dist_effectFunction.dual(2, (self, that) => self * that / gcd(self, that));
+
+/**
+ * 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
+ * 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
+ */
+const unsafeSqrt = n => {
+  if (n < bigint0) {
+    throw new RangeError("Cannot take the square root of a negative number");
+  }
+  if (n < bigint2) {
+    return n;
+  }
+  let x = n / bigint2;
+  while (x * x > n) {
+    x = (n / x + x) / bigint2;
+  }
+  return x;
+};
+
+/**
+ * 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
+ * import { sqrt } from 'effect/BigInt'
+ * import * as Option from 'effect/Option'
+ *
+ * assert.deepStrictEqual(sqrt(4n), Option.some(2n))
+ * assert.deepStrictEqual(sqrt(9n), Option.some(3n))
+ * assert.deepStrictEqual(sqrt(16n), Option.some(4n))
+ * assert.deepStrictEqual(sqrt(-1n), Option.none())
+ *
+ * @category math
+ * @since 2.0.0
+ */
+const sqrt = n => greaterThanOrEqualTo(n, bigint0) ? Option_dist_effectOption.some(unsafeSqrt(n)) : Option_dist_effectOption.none();
+
+/**
+ * Takes an `Iterable` of `bigint`s and returns their sum as a single `bigint
+ *
+ * @param collection - The collection of `bigint`s to sum.
+ *
+ * @example
+ * import { sumAll } from 'effect/BigInt'
+ *
+ * assert.deepStrictEqual(sumAll([2n, 3n, 4n]), 9n)
+ *
+ * @category math
+ * @since 2.0.0
+ */
+const sumAll = collection => {
+  let out = bigint0;
+  for (const n of collection) {
+    out += n;
+  }
+  return out;
+};
+
+/**
+ * Takes an `Iterable` of `bigint`s and returns their multiplication as a single `number`.
+ *
+ * @param collection - The collection of `bigint`s to multiply.
+ *
+ * @example
+ * import { multiplyAll } from 'effect/BigInt'
+ *
+ * assert.deepStrictEqual(multiplyAll([2n, 3n, 4n]), 24n)
+ *
+ * @category math
+ * @since 2.0.0
+ */
+const multiplyAll = collection => {
+  let out = bigint1;
+  for (const n of collection) {
+    if (n === bigint0) {
+      return bigint0;
+    }
+    out *= n;
+  }
+  return out;
+};
+
+exports.Equivalence = Equivalence;
+exports.Order = Order;
+exports.abs = abs;
+exports.between = between;
+exports.clamp = clamp;
+exports.decrement = decrement;
+exports.divide = divide;
+exports.gcd = gcd;
+exports.greaterThan = greaterThan;
+exports.greaterThanOrEqualTo = greaterThanOrEqualTo;
+exports.increment = increment;
+exports.isBigInt = isBigInt;
+exports.lcm = lcm;
+exports.lessThan = lessThan;
+exports.lessThanOrEqualTo = lessThanOrEqualTo;
+exports.max = max;
+exports.min = min;
+exports.multiply = multiply;
+exports.multiplyAll = multiplyAll;
+exports.sign = sign;
+exports.sqrt = sqrt;
+exports.subtract = subtract;
+exports.sum = sum;
+exports.sumAll = sumAll;
+exports.unsafeDivide = unsafeDivide;
+exports.unsafeSqrt = unsafeSqrt;

package/BigInt/dist/effect-BigInt.cjs.js

@@ -0,0 +1,7 @@
+'use strict';
+
+if (process.env.NODE_ENV === "production") {
+  module.exports = require("./effect-BigInt.cjs.prod.js");
+} else {
+  module.exports = require("./effect-BigInt.cjs.dev.js");
+}

package/BigInt/dist/effect-BigInt.cjs.mjs

@@ -0,0 +1,28 @@
+export {
+  Equivalence,
+  Order,
+  abs,
+  between,
+  clamp,
+  decrement,
+  divide,
+  gcd,
+  greaterThan,
+  greaterThanOrEqualTo,
+  increment,
+  isBigInt,
+  lcm,
+  lessThan,
+  lessThanOrEqualTo,
+  max,
+  min,
+  multiply,
+  multiplyAll,
+  sign,
+  sqrt,
+  subtract,
+  sum,
+  sumAll,
+  unsafeDivide,
+  unsafeSqrt
+} from "./effect-BigInt.cjs.js";