@tempots/std 0.12.0 → 0.13.0

package/index.js

@@ -1,39 +1,38 @@
-import { allElements as a, anyElement as i, applyArrayDiffOperations as t, areArraysEqual as s, arrayDiffOperations as o, arrayHasValues as n, arrayHead as l, arrayOfIterableIterator as m, arrayTail as p, compareArrays as c, concatArrays as y, createFilledArray as A, filterArray as f, filterMapArray as d, filterNullsFromArray as u, flatMapArray as C, flattenArray as b, foldLeftArray as h, forEachElement as v, generateArray as I, generateSequenceArray as E, isArrayEmpty as O, joinArrayWithConjunction as g, mapArray as x, rankArray as W, removeAllFromArray as q, removeAllFromArrayByPredicate as L, removeOneFromArray as F, removeOneFromArrayByPredicate as P, sortArray as j, uniqueByPredicate as w, uniquePrimitives as B } from "./array.js";
-import { AsyncResult as N } from "./async-result.js";
-import { biAbs as S, biCeilDiv as z, biCompare as T, biFloorDiv as M, biGcd as k, biIsEven as H, biIsNegative as V, biIsOdd as K, biIsOne as Q, biIsPositive as Z, biIsPrime as G, biIsZero as U, biLcm as J, biMax as X, biMin as Y, biNextPrime as _, biPow as $, biPrevPrime as ee } from "./bigint.js";
-import { deepEqual as ae, looseEqual as ie, strictEqual as te } from "./equal.js";
-import { compose as oe, curryLeft as ne, curryRight as le, flip as me, identity as pe, memoize as ce } from "./function.js";
-import { EPSILON as Ae, TOLERANCE as fe, angleDifference as de, ceilTo as ue, clamp as Ce, clampInt as be, clampSym as he, compare as ve, floorTo as Ie, interpolate as Ee, interpolateAngle as Oe, interpolateAngleCCW as ge, interpolateAngleCW as xe, interpolateWidestAngle as We, nearEqualAngles as qe, nearEquals as Le, nearZero as Fe, root as Pe, roundTo as je, sign as we, toHex as Be, widestAngleDifference as De, wrap as Ne, wrapCircular as Re } from "./number.js";
-import { isEmptyObject as ze, isObject as Te, mergeObjects as Me, objectKeys as ke, removeObjectFields as He, sameObjectKeys as Ve } from "./object.js";
-import { mapRegExp as Qe } from "./regexp.js";
-import { R as Ge, V as Ue } from "./result-Czm7RKNP.js";
-import { after as Xe, afterLast as Ye, before as _e, beforeLast as $e, canonicalizeNewlines as er, capitalize as rr, capitalizeWords as ar, collapse as ir, compareCaseInsensitive as tr, compareStrings as sr, contains as or, containsAll as nr, containsAllCaseInsensitive as lr, containsAny as mr, containsAnyCaseInsensitive as pr, containsCaseInsensitive as cr, count as yr, dasherize as Ar, decodeBase64 as fr, diffIndex as dr, ellipsis as ur, ellipsisMiddle as Cr, encodeBase64 as br, endsWith as hr, endsWithAny as vr, endsWithAnyCaseInsensitive as Ir, endsWithCaseInsensitive as Er, filter as Or, filterCharcode as gr, from as xr, hasContent as Wr, hashCode as qr, humanize as Lr, ifEmpty as Fr, isAlpha as Pr, isAlphaNum as jr, isBreakingWhitespace as wr, isDigitsOnly as Br, isEmpty as Dr, isLowerCase as Nr, isSpaceAt as Rr, isUpperCase as Sr, jsQuote as zr, lowerCaseFirst as Tr, lpad as Mr, map as kr, quote as Hr, random as Vr, randomSequence as Kr, randomSequence64 as Qr, remove as Zr, removeAfter as Gr, removeAt as Ur, removeBefore as Jr, removeOne as Xr, repeat as Yr, replace as _r, reverse as $r, rpad as ea, smartQuote as ra, splitOnFirst as aa, splitOnLast as ia, splitOnce as ta, startsWith as sa, startsWithAny as oa, startsWithAnyCaseInsensitive as na, startsWithCaseInsensitive as la, surround as ma, toArray as pa, toCharcodes as ca, toChunks as ya, toLines as Aa, trimChars as fa, trimCharsLeft as da, trimCharsRight as ua, underscore as Ca, upTo as ba, upperCaseFirst as ha, wrapColumns as va, wrapLine as Ia } from "./string.js";
+import { allElements as t, anyElement as i, applyArrayDiffOperations as a, areArraysEqual as s, arrayDiffOperations as n, arrayHasValues as o, arrayHead as l, arrayOfIterableIterator as m, arrayTail as p, compareArrays as c, concatArrays as y, createFilledArray as A, filterArray as f, filterMapArray as d, filterNullsFromArray as x, flatMapArray as g, flattenArray as u, foldLeftArray as C, forEachElement as b, generateArray as v, generateSequenceArray as h, isArrayEmpty as S, joinArrayWithConjunction as E, mapArray as I, rankArray as T, removeAllFromArray as O, removeAllFromArrayByPredicate as F, removeOneFromArray as W, removeOneFromArrayByPredicate as q, sortArray as L, uniqueByPredicate as P, uniquePrimitives as j } from "./array.js";
+import { AsyncResult as B } from "./async-result.js";
+import { biAbs as N, biCeilDiv as z, biCompare as H, biFloorDiv as M, biGcd as R, biIsEven as k, biIsNegative as V, biIsOdd as K, biIsOne as Q, biIsPositive as Z, biIsPrime as G, biIsZero as U, biLcm as J, biMax as X, biMin as Y, biNextPrime as _, biPow as $, biPrevPrime as ee } from "./bigint.js";
+import { deepEqual as te, looseEqual as ie, strictEqual as ae } from "./equal.js";
+import { curryLeft as ne, identity as oe, memoize as le } from "./function.js";
+import { EPSILON as pe, angleDifference as ce, ceilTo as ye, clamp as Ae, clampInt as fe, clampSym as de, compareNumbers as xe, floorTo as ge, interpolate as ue, interpolateAngle as Ce, interpolateAngleCCW as be, interpolateAngleCW as ve, interpolateWidestAngle as he, nearEqualAngles as Se, nearEquals as Ee, nearZero as Ie, root as Te, roundTo as Oe, sign as Fe, toHex as We, widestAngleDifference as qe, wrap as Le, wrapCircular as Pe } from "./number.js";
+import { isEmptyObject as we, isObject as Be, mergeObjects as De, objectKeys as Ne, removeObjectFields as ze, sameObjectKeys as He } from "./object.js";
+import { mapRegExp as Re } from "./regexp.js";
+import { R as Ve, V as Ke } from "./result-Czm7RKNP.js";
+import { afterLastText as Ze, afterText as Ge, beforeLastText as Ue, beforeText as Je, canonicalizeNewlines as Xe, capitalize as Ye, capitalizeWords as _e, chunkText as $e, compareCaseInsensitive as er, compareStrings as rr, containsAllText as tr, containsAllTextCaseInsensitive as ir, containsAnyText as ar, containsAnyTextCaseInsensitive as sr, countTextOccurrences as nr, dasherize as or, decodeBase64 as lr, ellipsis as mr, ellipsisMiddle as pr, encodeBase64 as cr, endsWithAnyText as yr, filterCharcode as Ar, filterText as fr, humanize as dr, ifEmptyString as xr, isAlpha as gr, isAlphaNum as ur, isBreakingWhitespace as Cr, isDigitsOnly as br, isEmptyString as vr, isLowerCase as hr, isSpaceAt as Sr, isUpperCase as Er, jsQuote as Ir, lowerCaseFirst as Tr, lpad as Or, mapChars as Fr, quote as Wr, randomString as qr, randomStringSequence as Lr, randomStringSequenceBase64 as Pr, removeFirstFromString as jr, removeFromString as wr, removeFromStringAfter as Br, removeFromStringBefore as Dr, removeSliceFromString as Nr, repeatString as zr, replaceAll as Hr, reverseString as Mr, rpad as Rr, smartQuote as kr, splitOnFirst as Vr, splitOnLast as Kr, splitStringOnce as Qr, stringHasContent as Zr, stringHashCode as Gr, stringToCharcodes as Ur, stringToChars as Jr, stringToLines as Xr, stringsDifferAtIndex as Yr, surroundText as _r, textCollapse as $r, textContains as et, textContainsCaseInsensitive as rt, textEndsWith as tt, textEndsWithAnyCaseInsensitive as it, textEndsWithCaseInsensitive as at, textStartsWith as st, textStartsWithAny as nt, textStartsWithAnyCaseInsensitive as ot, textStartsWithCaseInsensitive as lt, trimChars as mt, trimCharsLeft as pt, trimCharsRight as ct, underscore as yt, upperCaseFirst as At, wrapColumns as ft, wrapLine as dt } from "./string.js";
 export {
-  N as AsyncResult,
-  Ae as EPSILON,
-  Ge as Result,
-  fe as TOLERANCE,
-  Ue as Validation,
-  Xe as after,
-  Ye as afterLast,
-  a as allElements,
-  de as angleDifference,
+  B as AsyncResult,
+  pe as EPSILON,
+  Ve as Result,
+  Ke as Validation,
+  Ze as afterLastText,
+  Ge as afterText,
+  t as allElements,
+  ce as angleDifference,
   i as anyElement,
-  t as applyArrayDiffOperations,
+  a as applyArrayDiffOperations,
   s as areArraysEqual,
-  o as arrayDiffOperations,
-  n as arrayHasValues,
+  n as arrayDiffOperations,
+  o as arrayHasValues,
   l as arrayHead,
   m as arrayOfIterableIterator,
   p as arrayTail,
-  _e as before,
-  $e as beforeLast,
-  S as biAbs,
+  Ue as beforeLastText,
+  Je as beforeText,
+  N as biAbs,
   z as biCeilDiv,
-  T as biCompare,
+  H as biCompare,
   M as biFloorDiv,
-  k as biGcd,
-  H as biIsEven,
+  R as biGcd,
+  k as biIsEven,
   V as biIsNegative,
   K as biIsOdd,
   Q as biIsOne,
@@ -46,140 +45,135 @@ export {
   _ as biNextPrime,
   $ as biPow,
   ee as biPrevPrime,
-  er as canonicalizeNewlines,
-  rr as capitalize,
-  ar as capitalizeWords,
-  ue as ceilTo,
-  Ce as clamp,
-  be as clampInt,
-  he as clampSym,
-  ir as collapse,
-  ve as compare,
+  Xe as canonicalizeNewlines,
+  Ye as capitalize,
+  _e as capitalizeWords,
+  ye as ceilTo,
+  $e as chunkText,
+  Ae as clamp,
+  fe as clampInt,
+  de as clampSym,
   c as compareArrays,
-  tr as compareCaseInsensitive,
-  sr as compareStrings,
-  oe as compose,
+  er as compareCaseInsensitive,
+  xe as compareNumbers,
+  rr as compareStrings,
   y as concatArrays,
-  or as contains,
-  nr as containsAll,
-  lr as containsAllCaseInsensitive,
-  mr as containsAny,
-  pr as containsAnyCaseInsensitive,
-  cr as containsCaseInsensitive,
-  yr as count,
+  tr as containsAllText,
+  ir as containsAllTextCaseInsensitive,
+  ar as containsAnyText,
+  sr as containsAnyTextCaseInsensitive,
+  nr as countTextOccurrences,
   A as createFilledArray,
   ne as curryLeft,
-  le as curryRight,
-  Ar as dasherize,
-  fr as decodeBase64,
-  ae as deepEqual,
-  dr as diffIndex,
-  ur as ellipsis,
-  Cr as ellipsisMiddle,
-  br as encodeBase64,
-  hr as endsWith,
-  vr as endsWithAny,
-  Ir as endsWithAnyCaseInsensitive,
-  Er as endsWithCaseInsensitive,
-  Or as filter,
+  or as dasherize,
+  lr as decodeBase64,
+  te as deepEqual,
+  mr as ellipsis,
+  pr as ellipsisMiddle,
+  cr as encodeBase64,
+  yr as endsWithAnyText,
   f as filterArray,
-  gr as filterCharcode,
+  Ar as filterCharcode,
   d as filterMapArray,
-  u as filterNullsFromArray,
-  C as flatMapArray,
-  b as flattenArray,
-  me as flip,
-  Ie as floorTo,
-  h as foldLeftArray,
-  v as forEachElement,
-  xr as from,
-  I as generateArray,
-  E as generateSequenceArray,
-  Wr as hasContent,
-  qr as hashCode,
-  Lr as humanize,
-  pe as identity,
-  Fr as ifEmpty,
-  Ee as interpolate,
-  Oe as interpolateAngle,
-  ge as interpolateAngleCCW,
-  xe as interpolateAngleCW,
-  We as interpolateWidestAngle,
-  Pr as isAlpha,
-  jr as isAlphaNum,
-  O as isArrayEmpty,
-  wr as isBreakingWhitespace,
-  Br as isDigitsOnly,
-  Dr as isEmpty,
-  ze as isEmptyObject,
-  Nr as isLowerCase,
-  Te as isObject,
-  Rr as isSpaceAt,
-  Sr as isUpperCase,
-  g as joinArrayWithConjunction,
-  zr as jsQuote,
+  x as filterNullsFromArray,
+  fr as filterText,
+  g as flatMapArray,
+  u as flattenArray,
+  ge as floorTo,
+  C as foldLeftArray,
+  b as forEachElement,
+  v as generateArray,
+  h as generateSequenceArray,
+  dr as humanize,
+  oe as identity,
+  xr as ifEmptyString,
+  ue as interpolate,
+  Ce as interpolateAngle,
+  be as interpolateAngleCCW,
+  ve as interpolateAngleCW,
+  he as interpolateWidestAngle,
+  gr as isAlpha,
+  ur as isAlphaNum,
+  S as isArrayEmpty,
+  Cr as isBreakingWhitespace,
+  br as isDigitsOnly,
+  we as isEmptyObject,
+  vr as isEmptyString,
+  hr as isLowerCase,
+  Be as isObject,
+  Sr as isSpaceAt,
+  Er as isUpperCase,
+  E as joinArrayWithConjunction,
+  Ir as jsQuote,
   ie as looseEqual,
   Tr as lowerCaseFirst,
-  Mr as lpad,
-  kr as map,
-  x as mapArray,
-  Qe as mapRegExp,
-  ce as memoize,
-  Me as mergeObjects,
-  qe as nearEqualAngles,
-  Le as nearEquals,
-  Fe as nearZero,
-  ke as objectKeys,
-  Hr as quote,
-  Vr as random,
-  Kr as randomSequence,
-  Qr as randomSequence64,
-  W as rankArray,
-  Zr as remove,
-  Gr as removeAfter,
-  q as removeAllFromArray,
-  L as removeAllFromArrayByPredicate,
-  Ur as removeAt,
-  Jr as removeBefore,
-  He as removeObjectFields,
-  Xr as removeOne,
-  F as removeOneFromArray,
-  P as removeOneFromArrayByPredicate,
-  Yr as repeat,
-  _r as replace,
-  $r as reverse,
-  Pe as root,
-  je as roundTo,
-  ea as rpad,
-  Ve as sameObjectKeys,
-  we as sign,
-  ra as smartQuote,
-  j as sortArray,
-  aa as splitOnFirst,
-  ia as splitOnLast,
-  ta as splitOnce,
-  sa as startsWith,
-  oa as startsWithAny,
-  na as startsWithAnyCaseInsensitive,
-  la as startsWithCaseInsensitive,
-  te as strictEqual,
-  ma as surround,
-  pa as toArray,
-  ca as toCharcodes,
-  ya as toChunks,
-  Be as toHex,
-  Aa as toLines,
-  fa as trimChars,
-  da as trimCharsLeft,
-  ua as trimCharsRight,
-  Ca as underscore,
-  w as uniqueByPredicate,
-  B as uniquePrimitives,
-  ba as upTo,
-  ha as upperCaseFirst,
-  De as widestAngleDifference,
-  Ne as wrap,
-  Re as wrapCircular,
-  va as wrapColumns,
-  Ia as wrapLine
+  Or as lpad,
+  I as mapArray,
+  Fr as mapChars,
+  Re as mapRegExp,
+  le as memoize,
+  De as mergeObjects,
+  Se as nearEqualAngles,
+  Ee as nearEquals,
+  Ie as nearZero,
+  Ne as objectKeys,
+  Wr as quote,
+  qr as randomString,
+  Lr as randomStringSequence,
+  Pr as randomStringSequenceBase64,
+  T as rankArray,
+  O as removeAllFromArray,
+  F as removeAllFromArrayByPredicate,
+  jr as removeFirstFromString,
+  wr as removeFromString,
+  Br as removeFromStringAfter,
+  Dr as removeFromStringBefore,
+  ze as removeObjectFields,
+  W as removeOneFromArray,
+  q as removeOneFromArrayByPredicate,
+  Nr as removeSliceFromString,
+  zr as repeatString,
+  Hr as replaceAll,
+  Mr as reverseString,
+  Te as root,
+  Oe as roundTo,
+  Rr as rpad,
+  He as sameObjectKeys,
+  Fe as sign,
+  kr as smartQuote,
+  L as sortArray,
+  Vr as splitOnFirst,
+  Kr as splitOnLast,
+  Qr as splitStringOnce,
+  ae as strictEqual,
+  Zr as stringHasContent,
+  Gr as stringHashCode,
+  Ur as stringToCharcodes,
+  Jr as stringToChars,
+  Xr as stringToLines,
+  Yr as stringsDifferAtIndex,
+  _r as surroundText,
+  $r as textCollapse,
+  et as textContains,
+  rt as textContainsCaseInsensitive,
+  tt as textEndsWith,
+  it as textEndsWithAnyCaseInsensitive,
+  at as textEndsWithCaseInsensitive,
+  st as textStartsWith,
+  nt as textStartsWithAny,
+  ot as textStartsWithAnyCaseInsensitive,
+  lt as textStartsWithCaseInsensitive,
+  We as toHex,
+  mt as trimChars,
+  pt as trimCharsLeft,
+  ct as trimCharsRight,
+  yt as underscore,
+  P as uniqueByPredicate,
+  j as uniquePrimitives,
+  At as upperCaseFirst,
+  qe as widestAngleDifference,
+  Le as wrap,
+  Pe as wrapCircular,
+  ft as wrapColumns,
+  dt as wrapLine
 };

package/number.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const a=require("./string.cjs"),s=1e-4,l=1e-9;function f(e,n,t=360){let r=(n-e)%t;return r<0&&(r+=t),r>t/2&&(r-=t),r}function p(e,n){const t=Math.pow(10,n);return Math.ceil(e*t)/t}function c(e,n,t){return Math.min(Math.max(e,n),t)}function g(e,n,t){return Math.trunc(c(e,n,t))}function A(e,n){return c(e,-n,n)}function M(e,n){return e<n?-1:e>n?1:0}function h(e,n){const t=Math.pow(10,n);return Math.floor(e*t)/t}function d(e,n=0){return a.lpad(e.toString(16),"0",n)}function o(e,n,t){return(n-e)*t+e}function w(e,n,t,r=360){return i(o(e,e+f(e,n,r),t),r)}function u(e,n,t=360){let r=(n-e)%t;return r<0&&(r+=t),r>t/2&&(r-=t),r}function C(e,n,t,r=360){return i(o(e,e+u(e,n,r),t),r)}function E(e,n,t,r=360){return e=i(e,r),n=i(n,r),n<e&&(n+=r),i(o(e,n,t),r)}function N(e,n,t,r=360){return e=i(e,r),n=i(n,r),n>e&&(n-=r),i(o(e,n,t),r)}function T(e,n,t=l){return isFinite(e)?isFinite(n)?Math.abs(e-n)<=t:!1:isNaN(e)?isNaN(n):isNaN(n)||isFinite(n)?!1:e>0==n>0}function m(e,n,t=360,r=l){return Math.abs(f(e,n,t))<=r}function S(e,n=l){return Math.abs(e)<=n}function W(e,n){return Math.pow(e,1/n)}function q(e,n){const t=Math.pow(10,n);return Math.round(e*t)/t}function O(e){return e<0?-1:1}function y(e,n,t){const r=t-n+1;return e<n&&(e+=r*((n-e)/r+1)),n+(e-n)%r}function i(e,n){return e=e%n,e<0&&(e+=n),e}exports.EPSILON=l;exports.TOLERANCE=s;exports.angleDifference=f;exports.ceilTo=p;exports.clamp=c;exports.clampInt=g;exports.clampSym=A;exports.compare=M;exports.floorTo=h;exports.interpolate=o;exports.interpolateAngle=w;exports.interpolateAngleCCW=N;exports.interpolateAngleCW=E;exports.interpolateWidestAngle=C;exports.nearEqualAngles=m;exports.nearEquals=T;exports.nearZero=S;exports.root=W;exports.roundTo=q;exports.sign=O;exports.toHex=d;exports.widestAngleDifference=u;exports.wrap=y;exports.wrapCircular=i;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const a=require("./string.cjs"),l=1e-9;function u(e,n,t=360){let r=(n-e)%t;return r<0&&(r+=t),r>t/2&&(r-=t),r}function s(e,n){const t=Math.pow(10,n);return Math.ceil(e*t)/t}function f(e,n,t){return Math.min(Math.max(e,n),t)}function p(e,n,t){return Math.trunc(f(e,n,t))}function g(e,n){return f(e,-n,n)}function M(e,n){return e<n?-1:e>n?1:0}function h(e,n){const t=Math.pow(10,n);return Math.floor(e*t)/t}function A(e,n=0){return a.lpad(e.toString(16),"0",n)}function o(e,n,t){return(n-e)*t+e}function d(e,n,t,r=360){return i(o(e,e+u(e,n,r),t),r)}function c(e,n,t=360){let r=(n-e)%t;return r<0&&(r+=t),r>t/2&&(r-=t),r}function w(e,n,t,r=360){return i(o(e,e+c(e,n,r),t),r)}function N(e,n,t,r=360){return e=i(e,r),n=i(n,r),n<e&&(n+=r),i(o(e,n,t),r)}function m(e,n,t,r=360){return e=i(e,r),n=i(n,r),n>e&&(n-=r),i(o(e,n,t),r)}function C(e,n,t=l){return isFinite(e)?isFinite(n)?Math.abs(e-n)<=t:!1:isNaN(e)?isNaN(n):isNaN(n)||isFinite(n)?!1:e>0==n>0}function S(e,n,t=360,r=l){return Math.abs(u(e,n,t))<=r}function T(e,n=l){return Math.abs(e)<=n}function E(e,n){return Math.pow(e,1/n)}function W(e,n){const t=Math.pow(10,n);return Math.round(e*t)/t}function q(e){return e<0?-1:1}function y(e,n,t){const r=t-n+1;return e<n&&(e+=r*((n-e)/r+1)),n+(e-n)%r}function i(e,n){return e=e%n,e<0&&(e+=n),e}exports.EPSILON=l;exports.angleDifference=u;exports.ceilTo=s;exports.clamp=f;exports.clampInt=p;exports.clampSym=g;exports.compareNumbers=M;exports.floorTo=h;exports.interpolate=o;exports.interpolateAngle=d;exports.interpolateAngleCCW=m;exports.interpolateAngleCW=N;exports.interpolateWidestAngle=w;exports.nearEqualAngles=S;exports.nearEquals=C;exports.nearZero=T;exports.root=E;exports.roundTo=W;exports.sign=q;exports.toHex=A;exports.widestAngleDifference=c;exports.wrap=y;exports.wrapCircular=i;

package/number.d.ts

@@ -1,4 +1,3 @@
-export declare const TOLERANCE = 0.0001;
 /**
   Constant value employed to see if two `number` values are very close.
 **/
@@ -11,6 +10,7 @@ export declare const EPSILON = 1e-9;
  * @param turn - The total number of degrees in a full turn. Default is 360.0.
  * @returns The difference between the two angles.
  * @public
+ * @remarks
  * @example
  * ```ts
  * angleDifference(0, 90) // returns 90
@@ -27,6 +27,7 @@ export declare function angleDifference(a: number, b: number, turn?: number): nu
  * @param decimals - The number of decimals to round up to.
  * @returns The rounded up number.
  * @public
+ * @remarks
  * @example
  * ```ts
  * ceilTo(1.234, 2) // returns 1.24
@@ -43,6 +44,7 @@ export declare function ceilTo(v: number, decimals: number): number;
  * @param max - The maximum value.
  * @returns The clamped value.
  * @public
+ * @remarks
  * @example
  * ```ts
  * clamp(1.3, 0, 1) // returns 1
@@ -59,6 +61,7 @@ export declare function clamp(value: number, min: number, max: number): number;
  * @param max - The maximum value of the range.
  * @returns The clamped integer value.
  * @public
+ * @remarks
  * @example
  * ```ts
  * clampInt(5, 0, 10) // returns 5
@@ -75,6 +78,7 @@ export declare function clampInt(value: number, min: number, max: number): numbe
  * @param max - The maximum value.
  * @returns The clamped value.
  * @public
+ * @remarks
  * @example
  * ```ts
  * clampSym(5, 10) // returns 5
@@ -91,6 +95,7 @@ export declare function clampSym(v: number, max: number): number;
  * @param b - The second value to compare.
  * @returns A number indicating the relative order of the two values.
  * @public
+ * @remarks
  * @example
  * ```ts
  * compare(5, 10) // returns -1
@@ -98,7 +103,7 @@ export declare function clampSym(v: number, max: number): number;
  * compare(5, 5) // returns 0
  * ```
  **/
-export declare function compare(a: number, b: number): number;
+export declare function compareNumbers(a: number, b: number): number;
 /**
  * Rounds a number down to the specified number of decimals.
  *
@@ -106,6 +111,7 @@ export declare function compare(a: number, b: number): number;
  * @param decimals - The number of decimals to round down to.
  * @returns The rounded down number.
  * @public
+ * @remarks
  * @example
  * ```ts
  * floorTo(1.234, 2) // returns 1.23
@@ -121,6 +127,7 @@ export declare function floorTo(v: number, decimals: number): number;
  * @param length - The desired length of the hexadecimal string. Defaults to 0.
  * @returns The hexadecimal representation of the number.
  * @public
+ * @remarks
  * @example
  * ```ts
  * toHex(255) // returns 'ff'
@@ -137,6 +144,7 @@ export declare function toHex(num: number, length?: number): string;
  * @param t - The interpolation value.
  * @returns The interpolated value.
  * @public
+ * @remarks
  * @example
  * ```ts
  * interpolate(0, 10, 0.5) // returns 5
@@ -155,6 +163,7 @@ export declare function interpolate(a: number, b: number, t: number): number;
  * @param turn - The total number of degrees in a full turn. Default is 360.0.
  * @returns The interpolated angle.
  * @public
+ * @remarks
  * @example
  * ```ts
  * interpolateAngle(0, 90, 0.5) // returns 45
@@ -172,6 +181,7 @@ export declare function interpolateAngle(a: number, b: number, t: number, turn?:
  * @param turn - The total angle of a full turn. Defaults to 360 degrees.
  * @returns The widest angle difference between `a` and `b`.
  * @public
+ * @remarks
  * @example
  * ```ts
  * widestAngleDifference(0, 90) // returns 90
@@ -191,6 +201,7 @@ export declare function widestAngleDifference(a: number, b: number, turn?: numbe
  * @param turn - The total number of degrees in a full turn. Default is 360.0.
  * @returns The interpolated angle.
  * @public
+ * @remarks
  * @example
  * ```ts
  * interpolateWidestAngle(0, 90, 0.5) // returns 45
@@ -209,6 +220,7 @@ export declare function interpolateWidestAngle(a: number, b: number, t: number,
  * @param turn - The total number of degrees in a full turn. Default is 360.0.
  * @returns The interpolated angle.
  * @public
+ * @remarks
  * @example
  * ```ts
  * interpolateAngleCW(0, 90, 0.5) // returns 45
@@ -227,6 +239,7 @@ export declare function interpolateAngleCW(a: number, b: number, t: number, turn
  * @param turn - The total number of degrees in a full turn. Default is 360.0.
  * @returns The interpolated angle.
  * @public
+ * @remarks
  * @example
  * ```ts
  * interpolateAngleCCW(0, 90, 0.5) // returns 45
@@ -246,6 +259,7 @@ export declare function interpolateAngleCCW(a: number, b: number, t: number, tur
  * @param tollerance - The tollerance value. Default is `EPSILON`.
  * @returns `true` if the numbers are very close, `false` otherwise.
  * @public
+ * @remarks
  * @example
  * ```ts
  * nearEquals(5, 5.000000000000001) // returns true
@@ -266,6 +280,7 @@ export declare function nearEquals(a: number, b: number, tollerance?: number): b
  * @param tollerance - The tollerance value. Default is `EPSILON`.
  * @returns `true` if the angles are very close, `false` otherwise.
  * @public
+ * @remarks
  * @example
  * ```ts
  * nearEqualAngles(0, 360) // returns true
@@ -283,6 +298,7 @@ export declare function nearEqualAngles(a: number, b: number, turn?: number, tol
  * @param tollerance - The tollerance value. Default is `EPSILON`.
  * @returns `true` if the number is zero or very close to it, `false` otherwise.
  * @public
+ * @remarks
  * @example
  * ```ts
  * nearZero(0.000000000000001) // returns true
@@ -298,6 +314,7 @@ export declare function nearZero(n: number, tollerance?: number): boolean;
  * @param index - The index of the root.
  * @returns The nth root of the base number.
  * @public
+ * @remarks
  * @example
  * ```ts
  * root(8, 3) // returns 2
@@ -313,6 +330,7 @@ export declare function root(base: number, index: number): number;
  * @param decimals - The number of decimals to round to.
  * @returns The rounded number.
  * @public
+ * @remarks
  * @example
  * ```ts
  * roundTo(1.234, 2) // returns 1.23
@@ -327,6 +345,7 @@ export declare function roundTo(f: number, decimals: number): number;
  * @param value - The number to check.
  * @returns `-1` if the number is negative, `1` otherwise.
  * @public
+ * @remarks
  * @example
  * ```ts
  * sign(-5) // returns -1
@@ -345,6 +364,7 @@ export declare function sign<T extends number>(value: T): number;
  * @param max - The maximum value of the range.
  * @returns The wrapped value.
  * @public
+ * @remarks
  * @example
  * ```ts
  * wrap(5, 0, 10) // returns 5
@@ -360,6 +380,7 @@ export declare function wrap(v: number, min: number, max: number): number;
  * @param max - The maximum value of the range.
  * @returns The wrapped value.
  * @public
+ * @remarks
  * @example
  * ```ts
  * wrapCircular(5, 10) // returns 5

package/number.js

@@ -1,55 +1,55 @@
 import { lpad as l } from "./string.js";
-const p = 1e-4, f = 1e-9;
+const f = 1e-9;
 function u(n, t, e = 360) {
   let r = (t - n) % e;
   return r < 0 && (r += e), r > e / 2 && (r -= e), r;
 }
-function h(n, t) {
+function p(n, t) {
   const e = Math.pow(10, t);
   return Math.ceil(n * e) / e;
 }
 function c(n, t, e) {
   return Math.min(Math.max(n, t), e);
 }
-function M(n, t, e) {
+function h(n, t, e) {
   return Math.trunc(c(n, t, e));
 }
-function g(n, t) {
+function M(n, t) {
   return c(n, -t, t);
 }
-function N(n, t) {
+function g(n, t) {
   return n < t ? -1 : n > t ? 1 : 0;
 }
-function w(n, t) {
+function N(n, t) {
   const e = Math.pow(10, t);
   return Math.floor(n * e) / e;
 }
-function A(n, t = 0) {
+function w(n, t = 0) {
   return l(n.toString(16), "0", t);
 }
 function o(n, t, e) {
   return (t - n) * e + n;
 }
-function d(n, t, e, r = 360) {
+function A(n, t, e, r = 360) {
   return i(o(n, n + u(n, t, r), e), r);
 }
 function a(n, t, e = 360) {
   let r = (t - n) % e;
   return r < 0 && (r += e), r > e / 2 && (r -= e), r;
 }
-function C(n, t, e, r = 360) {
+function d(n, t, e, r = 360) {
   return i(
     o(n, n + a(n, t, r), e),
     r
   );
 }
-function E(n, t, e, r = 360) {
+function m(n, t, e, r = 360) {
   return n = i(n, r), t = i(t, r), t < n && (t += r), i(o(n, t, e), r);
 }
-function T(n, t, e, r = 360) {
+function C(n, t, e, r = 360) {
   return n = i(n, r), t = i(t, r), t > n && (t -= r), i(o(n, t, e), r);
 }
-function m(n, t, e = f) {
+function E(n, t, e = f) {
   return isFinite(n) ? isFinite(t) ? Math.abs(n - t) <= e : !1 : isNaN(n) ? isNaN(t) : isNaN(t) || isFinite(t) ? !1 : n > 0 == t > 0;
 }
 function F(n, t, e = 360, r = f) {
@@ -58,17 +58,17 @@ function F(n, t, e = 360, r = f) {
 function S(n, t = f) {
   return Math.abs(n) <= t;
 }
-function W(n, t) {
+function T(n, t) {
   return Math.pow(n, 1 / t);
 }
-function q(n, t) {
+function W(n, t) {
   const e = Math.pow(10, t);
   return Math.round(n * e) / e;
 }
-function D(n) {
+function q(n) {
   return n < 0 ? -1 : 1;
 }
-function I(n, t, e) {
+function D(n, t, e) {
   const r = e - t + 1;
   return n < t && (n += r * ((t - n) / r + 1)), t + (n - t) % r;
 }
@@ -77,27 +77,26 @@ function i(n, t) {
 }
 export {
   f as EPSILON,
-  p as TOLERANCE,
   u as angleDifference,
-  h as ceilTo,
+  p as ceilTo,
   c as clamp,
-  M as clampInt,
-  g as clampSym,
-  N as compare,
-  w as floorTo,
+  h as clampInt,
+  M as clampSym,
+  g as compareNumbers,
+  N as floorTo,
   o as interpolate,
-  d as interpolateAngle,
-  T as interpolateAngleCCW,
-  E as interpolateAngleCW,
-  C as interpolateWidestAngle,
+  A as interpolateAngle,
+  C as interpolateAngleCCW,
+  m as interpolateAngleCW,
+  d as interpolateWidestAngle,
   F as nearEqualAngles,
-  m as nearEquals,
+  E as nearEquals,
   S as nearZero,
-  W as root,
-  q as roundTo,
-  D as sign,
-  A as toHex,
+  T as root,
+  W as roundTo,
+  q as sign,
+  w as toHex,
   a as widestAngleDifference,
-  I as wrap,
+  D as wrap,
   i as wrapCircular
 };