@tempots/std 0.11.0 → 0.12.0

package/async-result.js

@@ -1,42 +1,146 @@
 const u = {
+  /**
+   * Creates a loading state.
+   * @param previousValue - The previous value.
+   * @returns A loading state.
+   * @public
+   */
   notAsked: { type: "NotAsked" },
+  /**
+   * Creates a loading state.
+   * @param previousValue - The previous value.
+   * @returns A loading state.
+   * @public
+   */
   loading(e = void 0) {
     return { type: "Loading", previousValue: e };
   },
+  /**
+   * Creates a successful state.
+   * @param value - The value.
+   * @returns A successful state.
+   * @public
+   */
   success(e) {
-    return { type: "Success", value: e };
+    return { type: "AsyncSuccess", value: e };
   },
+  /**
+   * Creates a failure state.
+   * @param error - The error.
+   * @returns A failure state.
+   * @public
+   */
   failure(e) {
-    return { type: "Failure", error: e };
+    return { type: "AsyncFailure", error: e };
   },
+  /**
+   * Checks if the result is a success.
+   * @param r - The result.
+   * @returns `true` if the result is a success; otherwise, `false`.
+   * @public
+   */
   isSuccess(e) {
-    return e.type === "Success";
+    return e.type === "AsyncSuccess";
   },
+  /**
+   * Checks if the result is a failure.
+   * @param r - The result.
+   * @returns `true` if the result is a failure; otherwise, `false`.
+   * @public
+   */
   isFailure(e) {
-    return e.type === "Failure";
+    return e.type === "AsyncFailure";
   },
+  /**
+   * Checks if the result is a not-asked.
+   * @param r - The result.
+   * @returns `true` if the result is not-asked; otherwise, `false`.
+   * @public
+   */
   isNotAsked(e) {
     return e.type === "NotAsked";
   },
+  /**
+   * Checks if the result is a loading.
+   * @param r - The result.
+   * @returns `true` if the result is loading; otherwise, `false`.
+   * @public
+   */
   isLoading(e) {
     return e.type === "Loading";
   },
+  /**
+   * Gets the value if the result is a success; otherwise, returns the alternative value.
+   * @param r - The result.
+   * @param alt - The alternative value.
+   * @returns The value if the result is a success; otherwise, the alternative value.
+   * @public
+   */
   getOrElse(e, s) {
     return u.isSuccess(e) ? e.value : s;
   },
+  /**
+   * Gets the value if the result is a success; otherwise, returns the value from the alternative function.
+   * @param r - The result.
+   * @param altf - The alternative function.
+   * @returns The value if the result is a success; otherwise, the value from the alternative
+   * @public
+   * function.
+   */
   getOrElseLazy(e, s) {
     return u.isSuccess(e) ? e.value : s();
   },
+  /**
+   * Gets the value if the result is a success; otherwise, returns `null`.
+   * @param r - The result.
+   * @returns The value if the result is a success; otherwise, `null`.
+   * @public
+   */
   getOrNull(e) {
     return u.isSuccess(e) ? e.value : null;
   },
+  /**
+   * Gets the value if the result is a success; otherwise, returns `undefined`.
+   * @param r - The result.
+   * @returns The value if the result is a success; otherwise, `undefined`.
+   * @public
+   */
   getOrUndefined(e) {
     return u.isSuccess(e) ? e.value : void 0;
   },
-  cmatch: (e, s, t, i = t) => (r) => u.isSuccess(r) ? e(r.value) : u.isFailure(r) ? s(r.error) : u.isNotAsked(r) ? i() : t(r.previousValue),
-  match: (e, s, t, i, r = i) => u.isSuccess(e) ? s(e.value) : u.isFailure(e) ? t(e.error) : u.isNotAsked(e) ? r() : i(e.previousValue),
-  whenSuccess: (e) => (s) => (u.isSuccess(s) && e(s.value), s),
-  whenFailure: (e) => (s) => (u.isFailure(s) && e(s.error), s)
+  /**
+   * Based on the state of the result, it picks the appropriate function to call and returns the result.
+   * @param success - The function to call if the result is a success.
+   * @param failure - The function to call if the result is a failure.
+   * @param loading - The function to call if the result is loading.
+   * @param notAsked - The function to call if the result is not-asked.
+   * @returns The result of calling the appropriate function based on the state of the result.
+   * @public
+   */
+  match: (e, {
+    success: s,
+    failure: t,
+    loading: r,
+    notAsked: i = r
+  }) => u.isSuccess(e) ? s(e.value) : u.isFailure(e) ? t(e.error) : u.isNotAsked(e) ? i() : r(e.previousValue),
+  /**
+   * When the result is a success, it applies the function to the value.
+   *
+   * @param r - The result.
+   * @param apply - The function to apply.
+   * @returns The result that was passed in.
+   * @public
+   */
+  whenSuccess: (e, s) => (u.isSuccess(e) && s(e.value), e),
+  /**
+   * When the result is a failure, it applies the function to the error.
+   *
+   * @param r - The result.
+   * @param apply - The function to apply.
+   * @returns The result that was passed in.
+   * @public
+   */
+  whenFailure: (e, s) => (u.isFailure(e) && s(e.error), e)
 };
 export {
   u as AsyncResult

package/bigint.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function o(n,e){return e<0n&&(n=-n,e=-e),n<=0n?n/e:(n-1n)/e+1n}function f(n,e){return e<0n&&(n=-n,e=-e),n>=0n?n/e:(n+1n)/e-1n}function c(n,e){return n<e?-1:n>e?1:0}function i(n){return n<0n?-n:n}function s(n,e){return n<e?n:e}function l(n,e){return n>e?n:e}function m(n,e){if(e<0n)throw new Error("negative exponent");let r=1n;for(;e>0n;)(e&1n)!==0n&&(r*=n),e>>=1n,n*=n;return r}function u(n,e){for(n=i(n),e=i(e);e>0n;){const r=e;e=n%e,n=r}return n}function v(n,e){return i(n*e)/u(n,e)}function t(n){if(n<2n)return!1;if(n===2n||n===3n)return!0;if(n%2n===0n||n%3n===0n)return!1;let e=5n;for(;e*e<=n;){if(n%e===0n||n%(e+2n)===0n)return!1;e+=6n}return!0}function a(n){if(n<2n)return 2n;if(n===2n)return 3n;for(n%2n===0n?n++:n+=2n;!t(n);)n+=2n;return n}function w(n){if(n<=2n)throw new Error("no previous prime");if(n===3n)return 2n;for(n%2n===0n?n--:n-=2n;!t(n);)n-=2n;return n}function p(n){return n%2n===0n}function P(n){return n%2n!==0n}function d(n){return n===0n}function g(n){return n===1n}function h(n){return n<0n}function O(n){return n>0n}exports.abs=i;exports.ceilDiv=o;exports.compare=c;exports.floorDiv=f;exports.gcd=u;exports.isEven=p;exports.isNegative=h;exports.isOdd=P;exports.isOne=g;exports.isPositive=O;exports.isPrime=t;exports.isZero=d;exports.lcm=v;exports.max=l;exports.min=s;exports.nextPrime=a;exports.pow=m;exports.prevPrime=w;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function o(n,i){return i<0n&&(n=-n,i=-i),n<=0n?n/i:(n-1n)/i+1n}function b(n,i){return i<0n&&(n=-n,i=-i),n>=0n?n/i:(n+1n)/i-1n}function f(n,i){return n<i?-1:n>i?1:0}function r(n){return n<0n?-n:n}function s(n,i){return n<i?n:i}function c(n,i){return n>i?n:i}function l(n,i){if(i<0n)throw new Error("negative exponent");let e=1n;for(;i>0n;)(i&1n)!==0n&&(e*=n),i>>=1n,n*=n;return e}function u(n,i){for(n=r(n),i=r(i);i>0n;){const e=i;i=n%i,n=e}return n}function v(n,i){return r(n*i)/u(n,i)}function t(n){if(n<2n)return!1;if(n===2n||n===3n)return!0;if(n%2n===0n||n%3n===0n)return!1;let i=5n;for(;i*i<=n;){if(n%i===0n||n%(i+2n)===0n)return!1;i+=6n}return!0}function I(n){if(n<2n)return 2n;if(n===2n)return 3n;for(n%2n===0n?n++:n+=2n;!t(n);)n+=2n;return n}function P(n){if(n<=2n)throw new Error("no previous prime");if(n===3n)return 2n;for(n%2n===0n?n--:n-=2n;!t(n);)n-=2n;return n}function a(n){return n%2n===0n}function m(n){return n%2n!==0n}function w(n){return n===0n}function d(n){return n===1n}function h(n){return n<0n}function p(n){return n>0n}exports.biAbs=r;exports.biCeilDiv=o;exports.biCompare=f;exports.biFloorDiv=b;exports.biGcd=u;exports.biIsEven=a;exports.biIsNegative=h;exports.biIsOdd=m;exports.biIsOne=d;exports.biIsPositive=p;exports.biIsPrime=t;exports.biIsZero=w;exports.biLcm=v;exports.biMax=c;exports.biMin=s;exports.biNextPrime=I;exports.biPow=l;exports.biPrevPrime=P;

package/bigint.d.ts

@@ -1,18 +1,155 @@
-export declare function ceilDiv(x: bigint, y: bigint): bigint;
-export declare function floorDiv(x: bigint, y: bigint): bigint;
-export declare function compare(x: bigint, y: bigint): number;
-export declare function abs(x: bigint): bigint;
-export declare function min(x: bigint, y: bigint): bigint;
-export declare function max(x: bigint, y: bigint): bigint;
-export declare function pow(x: bigint, y: bigint): bigint;
-export declare function gcd(x: bigint, y: bigint): bigint;
-export declare function lcm(x: bigint, y: bigint): bigint;
-export declare function isPrime(x: bigint): boolean;
-export declare function nextPrime(x: bigint): bigint;
-export declare function prevPrime(x: bigint): bigint;
-export declare function isEven(x: bigint): boolean;
-export declare function isOdd(x: bigint): boolean;
-export declare function isZero(x: bigint): boolean;
-export declare function isOne(x: bigint): boolean;
-export declare function isNegative(x: bigint): boolean;
-export declare function isPositive(x: bigint): boolean;
+/**
+ * Calculates the ceiling division of two BigInt numbers.
+ *
+ * @param x - The dividend.
+ * @param y - The divisor.
+ * @returns The result of dividing `x` by `y`, rounded up to the nearest whole number.
+ * @public
+ */
+export declare function biCeilDiv(x: bigint, y: bigint): bigint;
+/**
+ * Divides two BigInt numbers and returns the largest integer less than or equal to the quotient.
+ *
+ * @param x - The dividend.
+ * @param y - The divisor.
+ * @returns The largest integer less than or equal to the quotient of `x` divided by `y`.
+ * @public
+ */
+export declare function biFloorDiv(x: bigint, y: bigint): bigint;
+/**
+ * Compares two BigInt values and returns a number indicating their relative order.
+ * @param x - The first BigInt value to compare.
+ * @param y - The second BigInt value to compare.
+ * @returns A negative number if `x` is less than `y`, a positive number if `x` is greater than `y`,
+ * @public
+ *          or zero if `x` is equal to `y`.
+ */
+export declare function biCompare(x: bigint, y: bigint): number;
+/**
+ * Returns the absolute value of a bigint.
+ *
+ * @param x - The bigint to compute the absolute value of.
+ * @returns The absolute value of `x`.
+ * @public
+ */
+export declare function biAbs(x: bigint): bigint;
+/**
+ * Returns the minimum of two BigInt values.
+ *
+ * @param x - The first BigInt value.
+ * @param y - The second BigInt value.
+ * @returns The smaller of the two BigInt values.
+ * @public
+ */
+export declare function biMin(x: bigint, y: bigint): bigint;
+/**
+ * Returns the maximum of two BigInt values.
+ *
+ * @param x - The first BigInt value.
+ * @param y - The second BigInt value.
+ * @returns The maximum of the two BigInt values.
+ * @public
+ */
+export declare function biMax(x: bigint, y: bigint): bigint;
+/**
+ * Calculates the power of a bigint number.
+ *
+ * @param x - The base number.
+ * @param y - The exponent.
+ * @returns The result of raising `x` to the power of `y`.
+ * @public
+ * @throws Error If the exponent `y` is negative.
+ */
+export declare function biPow(x: bigint, y: bigint): bigint;
+/**
+ * Calculates the greatest common divisor (GCD) of two BigInt numbers.
+ *
+ * @param x - The first BigInt number.
+ * @param y - The second BigInt number.
+ * @returns The GCD of `x` and `y`.
+ * @public
+ */
+export declare function biGcd(x: bigint, y: bigint): bigint;
+/**
+ * Calculates the least common multiple (LCM) of two BigInt numbers.
+ *
+ * @param x - The first BigInt number.
+ * @param y - The second BigInt number.
+ * @returns The least common multiple of `x` and `y`.
+ * @public
+ */
+export declare function biLcm(x: bigint, y: bigint): bigint;
+/**
+ * Checks if a given number is prime.
+ *
+ * @param x - The number to check for primality.
+ * @returns `true` if the number is prime, `false` otherwise.
+ * @public
+ */
+export declare function biIsPrime(x: bigint): boolean;
+/**
+ * Finds the next prime number greater than the given number.
+ *
+ * @param x - The starting number.
+ * @returns The next prime number greater than `x`.
+ * @public
+ */
+export declare function biNextPrime(x: bigint): bigint;
+/**
+ * Returns the previous prime number less than the given number.
+ * Throws an error if there is no previous prime.
+ *
+ * @param x - The number to find the previous prime for.
+ * @returns The previous prime number less than `x`.
+ * @public
+ * @throws Error if there is no previous prime.
+ */
+export declare function biPrevPrime(x: bigint): bigint;
+/**
+ * Checks if a given bigint is even.
+ *
+ * @param x - The bigint to check.
+ * @returns `true` if the bigint is even, `false` otherwise.
+ * @public
+ */
+export declare function biIsEven(x: bigint): boolean;
+/**
+ * Checks if a given bigint is odd.
+ *
+ * @param x - The bigint to check.
+ * @returns `true` if the bigint is odd, `false` otherwise.
+ * @public
+ */
+export declare function biIsOdd(x: bigint): boolean;
+/**
+ * Checks if a given bigint is zero.
+ *
+ * @param x - The bigint to check.
+ * @returns `true` if the bigint is zero, `false` otherwise.
+ * @public
+ */
+export declare function biIsZero(x: bigint): boolean;
+/**
+ * Checks if a given bigint is equal to 1n.
+ *
+ * @param x - The bigint to check.
+ * @returns `true` if the bigint is equal to 1n, `false` otherwise.
+ * @public
+ */
+export declare function biIsOne(x: bigint): boolean;
+/**
+ * Checks if a given bigint is negative.
+ *
+ * @param x - The bigint to check.
+ * @returns `true` if the bigint is negative, `false` otherwise.
+ * @public
+ */
+export declare function biIsNegative(x: bigint): boolean;
+/**
+ * Checks if a bigint is positive.
+ *
+ * @param x - The bigint to check.
+ * @returns `true` if the bigint is positive, `false` otherwise.
+ * @public
+ */
+export declare function biIsPositive(x: bigint): boolean;

package/bigint.js

@@ -7,31 +7,31 @@ function o(n, r) {
 function c(n, r) {
   return n < r ? -1 : n > r ? 1 : 0;
 }
-function i(n) {
+function e(n) {
   return n < 0n ? -n : n;
 }
-function s(n, r) {
+function b(n, r) {
   return n < r ? n : r;
 }
-function l(n, r) {
+function s(n, r) {
   return n > r ? n : r;
 }
-function w(n, r) {
+function l(n, r) {
   if (r < 0n) throw new Error("negative exponent");
-  let e = 1n;
+  let i = 1n;
   for (; r > 0n; )
-    (r & 1n) !== 0n && (e *= n), r >>= 1n, n *= n;
-  return e;
+    (r & 1n) !== 0n && (i *= n), r >>= 1n, n *= n;
+  return i;
 }
 function u(n, r) {
-  for (n = i(n), r = i(r); r > 0n; ) {
-    const e = r;
-    r = n % r, n = e;
+  for (n = e(n), r = e(r); r > 0n; ) {
+    const i = r;
+    r = n % r, n = i;
   }
   return n;
 }
-function a(n, r) {
-  return i(n * r) / u(n, r);
+function w(n, r) {
+  return e(n * r) / u(n, r);
 }
 function t(n) {
   if (n < 2n) return !1;
@@ -44,13 +44,13 @@ function t(n) {
   }
   return !0;
 }
-function m(n) {
+function v(n) {
   if (n < 2n) return 2n;
   if (n === 2n) return 3n;
   for (n % 2n === 0n ? n++ : n += 2n; !t(n); ) n += 2n;
   return n;
 }
-function v(n) {
+function a(n) {
   if (n <= 2n) throw new Error("no previous prime");
   if (n === 3n) return 2n;
   for (n % 2n === 0n ? n-- : n -= 2n; !t(n); ) n -= 2n;
@@ -59,38 +59,38 @@ function v(n) {
 function h(n) {
   return n % 2n === 0n;
 }
-function p(n) {
+function I(n) {
   return n % 2n !== 0n;
 }
-function P(n) {
+function m(n) {
   return n === 0n;
 }
-function d(n) {
+function P(n) {
   return n === 1n;
 }
-function g(n) {
+function p(n) {
   return n < 0n;
 }
-function E(n) {
+function d(n) {
   return n > 0n;
 }
 export {
-  i as abs,
-  f as ceilDiv,
-  c as compare,
-  o as floorDiv,
-  u as gcd,
-  h as isEven,
-  g as isNegative,
-  p as isOdd,
-  d as isOne,
-  E as isPositive,
-  t as isPrime,
-  P as isZero,
-  a as lcm,
-  l as max,
-  s as min,
-  m as nextPrime,
-  w as pow,
-  v as prevPrime
+  e as biAbs,
+  f as biCeilDiv,
+  c as biCompare,
+  o as biFloorDiv,
+  u as biGcd,
+  h as biIsEven,
+  p as biIsNegative,
+  I as biIsOdd,
+  P as biIsOne,
+  d as biIsPositive,
+  t as biIsPrime,
+  m as biIsZero,
+  w as biLcm,
+  s as biMax,
+  b as biMin,
+  v as biNextPrime,
+  l as biPow,
+  a as biPrevPrime
 };

package/boolean.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function t(e,r){return e===r?0:e?-1:1}function a(e){return e?1:0}function n(e){if(e==null)return!1;switch(e.toLowerCase()){case"true":case"false":case"0":case"1":case"on":case"off":return!0;default:return!1}}function s(e){switch(e.toLowerCase()){case"true":case"1":case"on":return!0;case"false":case"0":case"off":return!1;default:throw new Error(`unable to parse '${e}'`)}}function o(e,r){return e!==r}exports.canParse=n;exports.compare=t;exports.parse=s;exports.toInt=a;exports.xor=o;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function a(e,o){return e===o?0:e?-1:1}function n(e){return e?1:0}function r(e){if(e==null)return!1;switch(e.toLowerCase()){case"true":case"false":case"0":case"1":case"on":case"off":return!0;default:return!1}}function t(e){switch(e.toLowerCase()){case"true":case"1":case"on":return!0;case"false":case"0":case"off":return!1;default:throw new Error(`unable to parse '${e}'`)}}function s(e,o){return e!==o}exports.booleanToInt=n;exports.canParseBoolean=r;exports.compareBooleans=a;exports.parseBoolean=t;exports.xorBoolean=s;

package/boolean.d.ts

@@ -3,21 +3,53 @@
  */
 /**
  * Returns a comparison value (`Int`) from two boolean values.
+ *
+ * @param a - The first boolean value.
+ * @param b - The second boolean value.
+ * @returns A comparison value.
+ * @public
  */
-export declare function compare(a: boolean, b: boolean): number;
+export declare function compareBooleans(a: boolean, b: boolean): number;
 /**
  * Converts a boolean to an integer value (`true` => `1`, `false` => `0`).
+ *
+ * @param v - The boolean value.
+ * @returns The integer value.
+ * @public
  */
-export declare function toInt(v: boolean): number;
+export declare function booleanToInt(v: boolean): number;
 /**
- * Returns `true` if the passed value is either `true` or `false` (case insensitive).
+ * Returns `true` if the passed value can be parsed as a boolean. The following values are considered parsable:
+ *
+ * - `'true'` / `'false'`
+ * - `'0'` / `'1'`
+ * - `'on'` / `'off'`
+ *
+ * The comparison is case insensitive.
+ *
+ * @param v - The value to check.
+ * @returns `true` if the value can be parsed; otherwise, `false`.
+ * @public
  */
-export declare function canParse(v: string): boolean;
+export declare function canParseBoolean(v: string): boolean;
 /**
- * Returns `true`/`false` if the passed value is `true`/`false` (case insensitive) with any other value it will return null.
+ * Returns `true`/`false` if the passed value can be parsed. The following values are considered parsable:
+ *
+ * - `'true'` / `'false'`
+ * - `'0'` / `'1'`
+ * - `'on'` / `'off'`
+ *
+ * @param v - The value to parse.
+ * @returns The parsed boolean value.
+ * @public
  */
-export declare function parse(v: string): boolean;
+export declare function parseBoolean(v: string): boolean;
 /**
  * Returns `true` when arguments are different.
+ *
+ * @param a - The first boolean value.
+ * @param b - The second boolean value.
+ * @returns The result of the XOR operation.
+ * @public
  */
-export declare function xor(a: boolean, b: boolean): boolean;
+export declare function xorBoolean(a: boolean, b: boolean): boolean;

package/boolean.js

@@ -1,10 +1,10 @@
-function t(e, r) {
+function a(e, r) {
   return e === r ? 0 : e ? -1 : 1;
 }
-function a(e) {
+function n(e) {
   return e ? 1 : 0;
 }
-function n(e) {
+function o(e) {
   if (e == null) return !1;
   switch (e.toLowerCase()) {
     case "true":
@@ -18,7 +18,7 @@ function n(e) {
       return !1;
   }
 }
-function s(e) {
+function t(e) {
   switch (e.toLowerCase()) {
     case "true":
     case "1":
@@ -32,13 +32,13 @@ function s(e) {
       throw new Error(`unable to parse '${e}'`);
   }
 }
-function c(e, r) {
+function s(e, r) {
   return e !== r;
 }
 export {
-  n as canParse,
-  t as compare,
-  s as parse,
-  a as toInt,
-  c as xor
+  n as booleanToInt,
+  o as canParseBoolean,
+  a as compareBooleans,
+  t as parseBoolean,
+  s as xorBoolean
 };