@studiometa/js-toolkit 3.1.0 → 3.2.0

package/utils/math/mean.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../packages/js-toolkit/utils/math/mean.ts"],
-  "sourcesContent": ["export function mean(numbers: number[]) {\n  if (numbers.length === 0) {\n    return 0;\n  }\n\n  if (numbers.length === 1) {\n    return numbers[0];\n  }\n\n  let sum = 0;\n  for (const value of numbers) {\n    sum += value;\n  }\n\n  return sum / numbers.length;\n}\n"],
-  "mappings": "AAAO,SAAS,KAAK,SAAmB;AACtC,MAAI,QAAQ,WAAW,GAAG;AACxB,WAAO;AAAA,EACT;AAEA,MAAI,QAAQ,WAAW,GAAG;AACxB,WAAO,QAAQ,CAAC;AAAA,EAClB;AAEA,MAAI,MAAM;AACV,aAAW,SAAS,SAAS;AAC3B,WAAO;AAAA,EACT;AAEA,SAAO,MAAM,QAAQ;AACvB;",
+  "sourcesContent": ["/**\n * @link https://js-toolkit.studiometa.dev/utils/math/mean.html\n */\nexport function mean(numbers: number[]) {\n  if (numbers.length === 0) {\n    return 0;\n  }\n\n  if (numbers.length === 1) {\n    return numbers[0];\n  }\n\n  let sum = 0;\n  for (const value of numbers) {\n    sum += value;\n  }\n\n  return sum / numbers.length;\n}\n"],
+  "mappings": "AAGO,SAAS,KAAK,SAAmB;AACtC,MAAI,QAAQ,WAAW,GAAG;AACxB,WAAO;AAAA,EACT;AAEA,MAAI,QAAQ,WAAW,GAAG;AACxB,WAAO,QAAQ,CAAC;AAAA,EAClB;AAEA,MAAI,MAAM;AACV,aAAW,SAAS,SAAS;AAC3B,WAAO;AAAA,EACT;AAEA,SAAO,MAAM,QAAQ;AACvB;",
   "names": []
 }

package/utils/math/round.d.ts

@@ -1,8 +1,9 @@
 /**
  * Round a value with a given number of decimals.
  *
- * @param   {number} value The number to round.
- * @param   {number} [decimals=0] The number of decimals to keep.
- * @returns {number} A rounded number to the given decimals length.
- */
+ * @param  {number} value The number to round.
+ * @param  {number} [decimals=0] The number of decimals to keep.
+ * @return {number} A rounded number to the given decimals length.
+ * @link https://js-toolkit.studiometa.dev/utils/math/round.html
+*/
 export declare function round(value: number, decimals?: number): number;

package/utils/math/round.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../packages/js-toolkit/utils/math/round.ts"],
-  "sourcesContent": ["/**\n * Round a value with a given number of decimals.\n *\n * @param   {number} value The number to round.\n * @param   {number} [decimals=0] The number of decimals to keep.\n * @returns {number} A rounded number to the given decimals length.\n */\nexport function round(value: number, decimals = 0) {\n  return Number(value.toFixed(decimals));\n}\n"],
-  "mappings": "AAOO,SAAS,MAAM,OAAe,WAAW,GAAG;AACjD,SAAO,OAAO,MAAM,QAAQ,QAAQ,CAAC;AACvC;",
+  "sourcesContent": ["/**\n * Round a value with a given number of decimals.\n *\n * @param  {number} value The number to round.\n * @param  {number} [decimals=0] The number of decimals to keep.\n * @return {number} A rounded number to the given decimals length.\n * @link https://js-toolkit.studiometa.dev/utils/math/round.html\n*/\nexport function round(value: number, decimals = 0) {\n  return Number(value.toFixed(decimals));\n}\n"],
+  "mappings": "AAQO,SAAS,MAAM,OAAe,WAAW,GAAG;AACjD,SAAO,OAAO,MAAM,QAAQ,QAAQ,CAAC;AACvC;",
   "names": []
 }

package/utils/math/smoothTo.d.ts

@@ -24,7 +24,7 @@ export type SmoothToOptions = Partial<{
  * Create a smoothing function that will smoothly tween between two values.
  * @param {number} [start] The initial value.
  * @param {SmoothToOptions} [options] Options for the transition.
- * @see https://js-toolkit.studiometa.dev/utils/math/smoothTo.html
+ * @link https://js-toolkit.studiometa.dev/utils/math/smoothTo.html
  * @example
  * ```js
  * const x = smoothTo(0);
@@ -43,6 +43,7 @@ export declare function smoothTo(start?: number, options?: SmoothToOptions): {
      */
     unsubscribe: (fn: (value: number) => any) => boolean;
     raw(): number;
+    add(val: number): number;
     damping(val?: number): number;
     precision(val?: number): number;
     stiffness(val?: number): number;

package/utils/math/smoothTo.js

@@ -1,10 +1,7 @@
-import { useRaf } from "../../services/RafService.js";
 import { damp } from "./damp.js";
 import { spring } from "./spring.js";
 import { isFunction, isDefined } from "../is.js";
 function smoothTo(start = 0, options = {}) {
-  const { add, has, remove } = useRaf();
-  const key = Symbol();
   const fns = /* @__PURE__ */ new Set();
   let damping = options.damping ?? 0.6;
   let precision = options.precision ?? 1 / 1e8;
@@ -23,7 +20,7 @@ function smoothTo(start = 0, options = {}) {
     for (const fn of fns) {
       fn(smoothed);
     }
-    if (smoothed === value) remove(key);
+    if (smoothed !== value) requestAnimationFrame(tick);
   }
   function subscribe(fn) {
     if (isFunction(fn)) {
@@ -39,14 +36,13 @@ function smoothTo(start = 0, options = {}) {
       return smoothed;
     }
     value = newValue;
-    if (!has(key)) {
-      add(key, tick);
-    }
+    tick();
     return smoothed;
   }
   update.subscribe = subscribe;
   update.unsubscribe = unsubscribe;
   update.raw = () => value;
+  update.add = (val) => update(value + val);
   update.damping = (val) => damping = val ?? damping;
   update.precision = (val) => precision = val ?? precision;
   update.stiffness = (val) => stiffness = val ?? stiffness;

package/utils/math/smoothTo.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../packages/js-toolkit/utils/math/smoothTo.ts"],
-  "sourcesContent": ["import { useRaf } from '../../services/RafService.js';\nimport { damp } from './damp.js';\nimport { spring } from './spring.js';\nimport { isFunction, isDefined } from '../is.js';\n\nexport type SmoothToOptions = Partial<{\n  /**\n   * Damping factor, the smaller the smoother, defaults to 0.6.\n   */\n  damping: number;\n  /**\n   * Precision used to decide when the smoothing should end, defaults to 1 / 1e8.\n   */\n  precision: number;\n  /**\n   * Enable spring physics, defaults to `true` if one of `stiffness` or `mass` is set, defaults to `false` otherwise.\n   */\n  spring: boolean;\n  /**\n   * Stiffness factor for spring physics, the higher the stiffer, defaults to 0.1.\n   */\n  stiffness: number;\n  /**\n   * Mass factor when spring is enabled, the higher the heavier, defaults to 1.\n   */\n  mass: number;\n}>;\n\n/**\n * Create a smoothing function that will smoothly tween between two values.\n * @param {number} [start] The initial value.\n * @param {SmoothToOptions} [options] Options for the transition.\n * @see https://js-toolkit.studiometa.dev/utils/math/smoothTo.html\n * @example\n * ```js\n * const x = smoothTo(0);\n * x.subscribe((value) => console.log(value));\n * x(100); // 0.1\n * ```\n */\nexport function smoothTo(start = 0, options: SmoothToOptions = {}) {\n  const { add, has, remove } = useRaf();\n  const key = Symbol();\n  const fns = new Set<(value: number) => any>();\n\n  let damping = options.damping ?? 0.6;\n  let precision = options.precision ?? 1 / 1e8;\n  let stiffness = options.stiffness ?? 0.1;\n  let mass = options.mass ?? 1;\n  let isSpring = options.spring === true || isDefined(options.stiffness) || isDefined(options.mass);\n\n  let value = start;\n  let smoothed = start;\n  let velocity = 0;\n\n  /**\n   * Callback for the useRaf service.\n   */\n  function tick() {\n    if (isSpring) {\n      [smoothed, velocity] = spring(value, smoothed, velocity, stiffness, damping, mass, precision);\n    } else {\n      smoothed = damp(value, smoothed, damping, precision);\n    }\n\n    for (const fn of fns) {\n      fn(smoothed);\n    }\n\n    if (smoothed === value) remove(key);\n  }\n\n  /**\n   * Subscribe a callback to the value update.\n   */\n  function subscribe(fn: (value: number) => any) {\n    if (isFunction(fn)) {\n      fns.add(fn);\n    }\n\n    return () => unsubscribe(fn);\n  }\n\n  /**\n   * Unsubscribe a callback to the value update.\n   */\n  function unsubscribe(fn: (value: number) => any) {\n    return fns.delete(fn);\n  }\n\n  /**\n   * Update the value if a parameter is given, get the value if no parameter is given.\n   */\n  function update(newValue?: number): number {\n    if (!isDefined(newValue)) {\n      return smoothed;\n    }\n\n    value = newValue;\n\n    if (!has(key)) {\n      add(key, tick);\n    }\n\n    return smoothed;\n  }\n\n  /**\n   * Subscribe a callback to the value update.\n   */\n  update.subscribe = subscribe;\n\n  /**\n   * Unsubscribe a callback from the value update.\n   */\n  update.unsubscribe = unsubscribe;\n\n  /**\n   * Get the raw target value.\n   */\n  update.raw = () => value;\n  /**\n   * Get or set the damping factor.\n   */\n  update.damping = (val?: number) => (damping = val ?? damping);\n\n  /**\n   * Get or set the precision.\n   */\n  update.precision = (val?: number) => (precision = val ?? precision);\n\n  /**\n   * Get or set the stiffness factor.\n   */\n  update.stiffness = (val?: number) => (stiffness = val ?? stiffness);\n\n  /**\n   * Get or set the spring option.\n   */\n  update.spring = (val?: boolean) => (isSpring = val ?? isSpring);\n\n  update(start);\n  return update;\n}\n"],
-  "mappings": "AAAA,SAAS,cAAc;AACvB,SAAS,YAAY;AACrB,SAAS,cAAc;AACvB,SAAS,YAAY,iBAAiB;AAqC/B,SAAS,SAAS,QAAQ,GAAG,UAA2B,CAAC,GAAG;AACjE,QAAM,EAAE,KAAK,KAAK,OAAO,IAAI,OAAO;AACpC,QAAM,MAAM,OAAO;AACnB,QAAM,MAAM,oBAAI,IAA4B;AAE5C,MAAI,UAAU,QAAQ,WAAW;AACjC,MAAI,YAAY,QAAQ,aAAa,IAAI;AACzC,MAAI,YAAY,QAAQ,aAAa;AACrC,MAAI,OAAO,QAAQ,QAAQ;AAC3B,MAAI,WAAW,QAAQ,WAAW,QAAQ,UAAU,QAAQ,SAAS,KAAK,UAAU,QAAQ,IAAI;AAEhG,MAAI,QAAQ;AACZ,MAAI,WAAW;AACf,MAAI,WAAW;AAKf,WAAS,OAAO;AACd,QAAI,UAAU;AACZ,OAAC,UAAU,QAAQ,IAAI,OAAO,OAAO,UAAU,UAAU,WAAW,SAAS,MAAM,SAAS;AAAA,IAC9F,OAAO;AACL,iBAAW,KAAK,OAAO,UAAU,SAAS,SAAS;AAAA,IACrD;AAEA,eAAW,MAAM,KAAK;AACpB,SAAG,QAAQ;AAAA,IACb;AAEA,QAAI,aAAa,MAAO,QAAO,GAAG;AAAA,EACpC;AAKA,WAAS,UAAU,IAA4B;AAC7C,QAAI,WAAW,EAAE,GAAG;AAClB,UAAI,IAAI,EAAE;AAAA,IACZ;AAEA,WAAO,MAAM,YAAY,EAAE;AAAA,EAC7B;AAKA,WAAS,YAAY,IAA4B;AAC/C,WAAO,IAAI,OAAO,EAAE;AAAA,EACtB;AAKA,WAAS,OAAO,UAA2B;AACzC,QAAI,CAAC,UAAU,QAAQ,GAAG;AACxB,aAAO;AAAA,IACT;AAEA,YAAQ;AAER,QAAI,CAAC,IAAI,GAAG,GAAG;AACb,UAAI,KAAK,IAAI;AAAA,IACf;AAEA,WAAO;AAAA,EACT;AAKA,SAAO,YAAY;AAKnB,SAAO,cAAc;AAKrB,SAAO,MAAM,MAAM;AAInB,SAAO,UAAU,CAAC,QAAkB,UAAU,OAAO;AAKrD,SAAO,YAAY,CAAC,QAAkB,YAAY,OAAO;AAKzD,SAAO,YAAY,CAAC,QAAkB,YAAY,OAAO;AAKzD,SAAO,SAAS,CAAC,QAAmB,WAAW,OAAO;AAEtD,SAAO,KAAK;AACZ,SAAO;AACT;",
+  "sourcesContent": ["import { damp } from './damp.js';\nimport { spring } from './spring.js';\nimport { isFunction, isDefined } from '../is.js';\n\nexport type SmoothToOptions = Partial<{\n  /**\n   * Damping factor, the smaller the smoother, defaults to 0.6.\n   */\n  damping: number;\n  /**\n   * Precision used to decide when the smoothing should end, defaults to 1 / 1e8.\n   */\n  precision: number;\n  /**\n   * Enable spring physics, defaults to `true` if one of `stiffness` or `mass` is set, defaults to `false` otherwise.\n   */\n  spring: boolean;\n  /**\n   * Stiffness factor for spring physics, the higher the stiffer, defaults to 0.1.\n   */\n  stiffness: number;\n  /**\n   * Mass factor when spring is enabled, the higher the heavier, defaults to 1.\n   */\n  mass: number;\n}>;\n\n/**\n * Create a smoothing function that will smoothly tween between two values.\n * @param {number} [start] The initial value.\n * @param {SmoothToOptions} [options] Options for the transition.\n * @link https://js-toolkit.studiometa.dev/utils/math/smoothTo.html\n * @example\n * ```js\n * const x = smoothTo(0);\n * x.subscribe((value) => console.log(value));\n * x(100); // 0.1\n * ```\n */\nexport function smoothTo(start = 0, options: SmoothToOptions = {}) {\n  const fns = new Set<(value: number) => any>();\n\n  let damping = options.damping ?? 0.6;\n  let precision = options.precision ?? 1 / 1e8;\n  let stiffness = options.stiffness ?? 0.1;\n  let mass = options.mass ?? 1;\n  let isSpring = options.spring === true || isDefined(options.stiffness) || isDefined(options.mass);\n\n  let value = start;\n  let smoothed = start;\n  let velocity = 0;\n\n  /**\n   * Callback for the useRaf service.\n   */\n  function tick() {\n    if (isSpring) {\n      [smoothed, velocity] = spring(value, smoothed, velocity, stiffness, damping, mass, precision);\n    } else {\n      smoothed = damp(value, smoothed, damping, precision);\n    }\n\n    for (const fn of fns) {\n      fn(smoothed);\n    }\n\n    if (smoothed !== value) requestAnimationFrame(tick);\n  }\n\n  /**\n   * Subscribe a callback to the value update.\n   */\n  function subscribe(fn: (value: number) => any) {\n    if (isFunction(fn)) {\n      fns.add(fn);\n    }\n\n    return () => unsubscribe(fn);\n  }\n\n  /**\n   * Unsubscribe a callback to the value update.\n   */\n  function unsubscribe(fn: (value: number) => any) {\n    return fns.delete(fn);\n  }\n\n  /**\n   * Update the value if a parameter is given, get the value if no parameter is given.\n   */\n  function update(newValue?: number): number {\n    if (!isDefined(newValue)) {\n      return smoothed;\n    }\n\n    value = newValue;\n\n    tick();\n\n    return smoothed;\n  }\n\n  /**\n   * Subscribe a callback to the value update.\n   */\n  update.subscribe = subscribe;\n\n  /**\n   * Unsubscribe a callback from the value update.\n   */\n  update.unsubscribe = unsubscribe;\n\n  /**\n   * Get the raw target value.\n   */\n  update.raw = () => value;\n\n  /**\n   * Add the given value to the current raw value.\n   */\n  update.add = (val: number) => update(value + val);\n\n  /**\n   * Get or set the damping factor.\n   */\n  update.damping = (val?: number) => (damping = val ?? damping);\n\n  /**\n   * Get or set the precision.\n   */\n  update.precision = (val?: number) => (precision = val ?? precision);\n\n  /**\n   * Get or set the stiffness factor.\n   */\n  update.stiffness = (val?: number) => (stiffness = val ?? stiffness);\n\n  /**\n   * Get or set the spring option.\n   */\n  update.spring = (val?: boolean) => (isSpring = val ?? isSpring);\n\n  update(start);\n  return update;\n}\n"],
+  "mappings": "AAAA,SAAS,YAAY;AACrB,SAAS,cAAc;AACvB,SAAS,YAAY,iBAAiB;AAqC/B,SAAS,SAAS,QAAQ,GAAG,UAA2B,CAAC,GAAG;AACjE,QAAM,MAAM,oBAAI,IAA4B;AAE5C,MAAI,UAAU,QAAQ,WAAW;AACjC,MAAI,YAAY,QAAQ,aAAa,IAAI;AACzC,MAAI,YAAY,QAAQ,aAAa;AACrC,MAAI,OAAO,QAAQ,QAAQ;AAC3B,MAAI,WAAW,QAAQ,WAAW,QAAQ,UAAU,QAAQ,SAAS,KAAK,UAAU,QAAQ,IAAI;AAEhG,MAAI,QAAQ;AACZ,MAAI,WAAW;AACf,MAAI,WAAW;AAKf,WAAS,OAAO;AACd,QAAI,UAAU;AACZ,OAAC,UAAU,QAAQ,IAAI,OAAO,OAAO,UAAU,UAAU,WAAW,SAAS,MAAM,SAAS;AAAA,IAC9F,OAAO;AACL,iBAAW,KAAK,OAAO,UAAU,SAAS,SAAS;AAAA,IACrD;AAEA,eAAW,MAAM,KAAK;AACpB,SAAG,QAAQ;AAAA,IACb;AAEA,QAAI,aAAa,MAAO,uBAAsB,IAAI;AAAA,EACpD;AAKA,WAAS,UAAU,IAA4B;AAC7C,QAAI,WAAW,EAAE,GAAG;AAClB,UAAI,IAAI,EAAE;AAAA,IACZ;AAEA,WAAO,MAAM,YAAY,EAAE;AAAA,EAC7B;AAKA,WAAS,YAAY,IAA4B;AAC/C,WAAO,IAAI,OAAO,EAAE;AAAA,EACtB;AAKA,WAAS,OAAO,UAA2B;AACzC,QAAI,CAAC,UAAU,QAAQ,GAAG;AACxB,aAAO;AAAA,IACT;AAEA,YAAQ;AAER,SAAK;AAEL,WAAO;AAAA,EACT;AAKA,SAAO,YAAY;AAKnB,SAAO,cAAc;AAKrB,SAAO,MAAM,MAAM;AAKnB,SAAO,MAAM,CAAC,QAAgB,OAAO,QAAQ,GAAG;AAKhD,SAAO,UAAU,CAAC,QAAkB,UAAU,OAAO;AAKrD,SAAO,YAAY,CAAC,QAAkB,YAAY,OAAO;AAKzD,SAAO,YAAY,CAAC,QAAkB,YAAY,OAAO;AAKzD,SAAO,SAAS,CAAC,QAAmB,WAAW,OAAO;AAEtD,SAAO,KAAK;AACZ,SAAO;AACT;",
   "names": []
 }

package/utils/math/spring.d.ts

@@ -1,13 +1,13 @@
 /**
  * Get the next spring value using velocity and spring physics.
- * @param   {number} targetValue The final value.
- * @param   {number} currentValue The current value.
- * @param   {number} currentVelocity The current velocity.
- * @param   {number} [stiffness=0.1] The spring stiffness (or tension) factor, defaults to 0.1.
- * @param   {number} [damping=0.8] The damping factor (or friction) to reduce oscillation, defaults to 0.6.
- * @param   {number} [mass=1] The mass factor affecting acceleration, defaults to 1.
- * @param   {number} [precision=1/1e4] The precision used to calculate the latest value, defaults to 1/1e4.
- * @returns {[number, number]} The next value and velocity.
- * @see https://js-toolkit.studiometa.dev/utils/math/spring.html
+ * @param  {number} targetValue The final value.
+ * @param  {number} currentValue The current value.
+ * @param  {number} currentVelocity The current velocity.
+ * @param  {number} [stiffness=0.1] The spring stiffness (or tension) factor, defaults to 0.1.
+ * @param  {number} [damping=0.8] The damping factor (or friction) to reduce oscillation, defaults to 0.6.
+ * @param  {number} [mass=1] The mass factor affecting acceleration, defaults to 1.
+ * @param  {number} [precision=1/1e4] The precision used to calculate the latest value, defaults to 1/1e4.
+ * @return {[number, number]} The next value and velocity.
+ * @link https://js-toolkit.studiometa.dev/utils/math/spring.html
  */
 export declare function spring(targetValue: number, currentValue: number, currentVelocity: number, stiffness?: number, damping?: number, mass?: number, precision?: number): [number, number];

package/utils/math/spring.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../packages/js-toolkit/utils/math/spring.ts"],
-  "sourcesContent": ["/**\n * Get the next spring value using velocity and spring physics.\n * @param   {number} targetValue The final value.\n * @param   {number} currentValue The current value.\n * @param   {number} currentVelocity The current velocity.\n * @param   {number} [stiffness=0.1] The spring stiffness (or tension) factor, defaults to 0.1.\n * @param   {number} [damping=0.8] The damping factor (or friction) to reduce oscillation, defaults to 0.6.\n * @param   {number} [mass=1] The mass factor affecting acceleration, defaults to 1.\n * @param   {number} [precision=1/1e4] The precision used to calculate the latest value, defaults to 1/1e4.\n * @returns {[number, number]} The next value and velocity.\n * @see https://js-toolkit.studiometa.dev/utils/math/spring.html\n */\nexport function spring(\n  targetValue: number,\n  currentValue: number,\n  currentVelocity: number,\n  stiffness = 0.1,\n  damping = 0.6,\n  mass = 1,\n  precision = 1 / 1e4,\n): [number, number] {\n  const force = (targetValue - currentValue) * stiffness;\n  const acceleration = force / mass;\n  const velocity = currentVelocity * damping + acceleration;\n  const value =\n    Math.abs(targetValue - currentValue) < precision && Math.abs(velocity) < precision\n      ? targetValue\n      : currentValue + velocity;\n\n  return [value, value === targetValue ? 0 : velocity];\n}\n"],
+  "sourcesContent": ["/**\n * Get the next spring value using velocity and spring physics.\n * @param  {number} targetValue The final value.\n * @param  {number} currentValue The current value.\n * @param  {number} currentVelocity The current velocity.\n * @param  {number} [stiffness=0.1] The spring stiffness (or tension) factor, defaults to 0.1.\n * @param  {number} [damping=0.8] The damping factor (or friction) to reduce oscillation, defaults to 0.6.\n * @param  {number} [mass=1] The mass factor affecting acceleration, defaults to 1.\n * @param  {number} [precision=1/1e4] The precision used to calculate the latest value, defaults to 1/1e4.\n * @return {[number, number]} The next value and velocity.\n * @link https://js-toolkit.studiometa.dev/utils/math/spring.html\n */\nexport function spring(\n  targetValue: number,\n  currentValue: number,\n  currentVelocity: number,\n  stiffness = 0.1,\n  damping = 0.6,\n  mass = 1,\n  precision = 1 / 1e4,\n): [number, number] {\n  const force = (targetValue - currentValue) * stiffness;\n  const acceleration = force / mass;\n  const velocity = currentVelocity * damping + acceleration;\n  const value =\n    Math.abs(targetValue - currentValue) < precision && Math.abs(velocity) < precision\n      ? targetValue\n      : currentValue + velocity;\n\n  return [value, value === targetValue ? 0 : velocity];\n}\n"],
   "mappings": "AAYO,SAAS,OACd,aACA,cACA,iBACA,YAAY,KACZ,UAAU,KACV,OAAO,GACP,YAAY,IAAI,KACE;AAClB,QAAM,SAAS,cAAc,gBAAgB;AAC7C,QAAM,eAAe,QAAQ;AAC7B,QAAM,WAAW,kBAAkB,UAAU;AAC7C,QAAM,QACJ,KAAK,IAAI,cAAc,YAAY,IAAI,aAAa,KAAK,IAAI,QAAQ,IAAI,YACrE,cACA,eAAe;AAErB,SAAO,CAAC,OAAO,UAAU,cAAc,IAAI,QAAQ;AACrD;",
   "names": []
 }

package/utils/math/wrap.d.ts

@@ -1,4 +1,5 @@
 /**
  * Wrap a value in the min and max range.
- */
+ * @link https://js-toolkit.studiometa.dev/utils/math/wrap.html
+*/
 export declare function wrap(value: number, min: number, max: number): number;

package/utils/math/wrap.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../packages/js-toolkit/utils/math/wrap.ts"],
-  "sourcesContent": ["/**\n * Wrap a value in the min and max range.\n */\nexport function wrap(value: number, min: number, max: number): number {\n  const range = max - min;\n  return min === max ? min : ((range + ((value - min) % range)) % range) + min;\n}\n"],
-  "mappings": "AAGO,SAAS,KAAK,OAAe,KAAa,KAAqB;AACpE,QAAM,QAAQ,MAAM;AACpB,SAAO,QAAQ,MAAM,OAAQ,SAAU,QAAQ,OAAO,SAAU,QAAS;AAC3E;",
+  "sourcesContent": ["/**\n * Wrap a value in the min and max range.\n * @link https://js-toolkit.studiometa.dev/utils/math/wrap.html\n*/\nexport function wrap(value: number, min: number, max: number): number {\n  const range = max - min;\n  return min === max ? min : ((range + ((value - min) % range)) % range) + min;\n}\n"],
+  "mappings": "AAIO,SAAS,KAAK,OAAe,KAAa,KAAqB;AACpE,QAAM,QAAQ,MAAM;AACpB,SAAO,QAAQ,MAAM,OAAQ,SAAU,QAAQ,OAAO,SAAU,QAAS;AAC3E;",
   "names": []
 }

package/utils/memo.d.ts

@@ -1,5 +1,6 @@
 /**
  * Memoize the result of a function with a single argument indefinitely.
  * This is a simpler implementation of the `memoize` function.
- */
+ * @link https://js-toolkit.studiometa.dev/utils/memo.html
+*/
 export declare function memo<T extends (...args: unknown[]) => unknown>(fn: T): T;

package/utils/memo.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../packages/js-toolkit/utils/memo.ts"],
-  "sourcesContent": ["/**\n * Memoize the result of a function with a single argument indefinitely.\n * This is a simpler implementation of the `memoize` function.\n */\nexport function memo<T extends (...args: unknown[]) => unknown>(fn: T): T {\n  const cache = new Map<string, ReturnType<T>>();\n\n  // @ts-ignore\n  return function cached(...args) {\n    const key = args.join('');\n    if (!cache.has(key)) {\n      cache.set(key, fn(...args) as ReturnType<T>);\n    }\n    return cache.get(key);\n  };\n}\n"],
-  "mappings": "AAIO,SAAS,KAAgD,IAAU;AACxE,QAAM,QAAQ,oBAAI,IAA2B;AAG7C,SAAO,SAAS,UAAU,MAAM;AAC9B,UAAM,MAAM,KAAK,KAAK,EAAE;AACxB,QAAI,CAAC,MAAM,IAAI,GAAG,GAAG;AACnB,YAAM,IAAI,KAAK,GAAG,GAAG,IAAI,CAAkB;AAAA,IAC7C;AACA,WAAO,MAAM,IAAI,GAAG;AAAA,EACtB;AACF;",
+  "sourcesContent": ["/**\n * Memoize the result of a function with a single argument indefinitely.\n * This is a simpler implementation of the `memoize` function.\n * @link https://js-toolkit.studiometa.dev/utils/memo.html\n*/\nexport function memo<T extends (...args: unknown[]) => unknown>(fn: T): T {\n  const cache = new Map<string, ReturnType<T>>();\n\n  // @ts-ignore\n  return function cached(...args) {\n    const key = args.join('');\n    if (!cache.has(key)) {\n      cache.set(key, fn(...args) as ReturnType<T>);\n    }\n    return cache.get(key);\n  };\n}\n"],
+  "mappings": "AAKO,SAAS,KAAgD,IAAU;AACxE,QAAM,QAAQ,oBAAI,IAA2B;AAG7C,SAAO,SAAS,UAAU,MAAM;AAC9B,UAAM,MAAM,KAAK,KAAK,EAAE;AACxB,QAAI,CAAC,MAAM,IAAI,GAAG,GAAG;AACnB,YAAM,IAAI,KAAK,GAAG,GAAG,IAAI,CAAkB;AAAA,IAC7C;AACA,WAAO,MAAM,IAAI,GAAG;AAAA,EACtB;AACF;",
   "names": []
 }

package/utils/memoize.d.ts

@@ -16,5 +16,6 @@ export interface MemoizeOptions<T> {
 }
 /**
  * Memoize the output of a function.
- */
+ * @link https://js-toolkit.studiometa.dev/utils/memoize.html
+*/
 export declare function memoize<T extends (...args: unknown[]) => unknown>(fn: T, { maxAge, cacheKey, cache, }?: MemoizeOptions<ReturnType<T>>): (...args: Parameters<T>) => ReturnType<T>;

package/utils/memoize.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../packages/js-toolkit/utils/memoize.ts"],
-  "sourcesContent": ["export interface MemoizeCache<T> {\n  has: (key: unknown) => boolean;\n  set: (key: unknown, value: { data: T; date: number }) => this;\n  get: (key: unknown) => { data: T; date: number };\n}\n\nexport interface MemoizeOptions<T> {\n  maxAge?: number;\n  cacheKey?: (args: unknown[]) => string;\n  cache?: MemoizeCache<T>;\n}\n\n/**\n * Memoize the output of a function.\n */\nexport function memoize<T extends (...args: unknown[]) => unknown>(\n  fn: T,\n  {\n    maxAge = Number.POSITIVE_INFINITY,\n    cacheKey = JSON.stringify,\n    cache = new Map(),\n  }: MemoizeOptions<ReturnType<T>> = {},\n): (...args: Parameters<T>) => ReturnType<T> {\n  return function memoized(...args): ReturnType<T> {\n    const key = cacheKey(args);\n    const date = Date.now();\n\n    if (cache.has(key)) {\n      const cached = cache.get(key);\n\n      if (date - cached.date < maxAge) {\n        return cached.data;\n      }\n    }\n\n    // @ts-ignore\n    const data: ReturnType<T> = fn(...args);\n\n    cache.set(key, {\n      data,\n      date: Date.now(),\n    });\n\n    return data;\n  };\n}\n"],
-  "mappings": "AAeO,SAAS,QACd,IACA;AAAA,EACE,SAAS,OAAO;AAAA,EAChB,WAAW,KAAK;AAAA,EAChB,QAAQ,oBAAI,IAAI;AAClB,IAAmC,CAAC,GACO;AAC3C,SAAO,SAAS,YAAY,MAAqB;AAC/C,UAAM,MAAM,SAAS,IAAI;AACzB,UAAM,OAAO,KAAK,IAAI;AAEtB,QAAI,MAAM,IAAI,GAAG,GAAG;AAClB,YAAM,SAAS,MAAM,IAAI,GAAG;AAE5B,UAAI,OAAO,OAAO,OAAO,QAAQ;AAC/B,eAAO,OAAO;AAAA,MAChB;AAAA,IACF;AAGA,UAAM,OAAsB,GAAG,GAAG,IAAI;AAEtC,UAAM,IAAI,KAAK;AAAA,MACb;AAAA,MACA,MAAM,KAAK,IAAI;AAAA,IACjB,CAAC;AAED,WAAO;AAAA,EACT;AACF;",
+  "sourcesContent": ["export interface MemoizeCache<T> {\n  has: (key: unknown) => boolean;\n  set: (key: unknown, value: { data: T; date: number }) => this;\n  get: (key: unknown) => { data: T; date: number };\n}\n\nexport interface MemoizeOptions<T> {\n  maxAge?: number;\n  cacheKey?: (args: unknown[]) => string;\n  cache?: MemoizeCache<T>;\n}\n\n/**\n * Memoize the output of a function.\n * @link https://js-toolkit.studiometa.dev/utils/memoize.html\n*/\nexport function memoize<T extends (...args: unknown[]) => unknown>(\n  fn: T,\n  {\n    maxAge = Number.POSITIVE_INFINITY,\n    cacheKey = JSON.stringify,\n    cache = new Map(),\n  }: MemoizeOptions<ReturnType<T>> = {},\n): (...args: Parameters<T>) => ReturnType<T> {\n  return function memoized(...args): ReturnType<T> {\n    const key = cacheKey(args);\n    const date = Date.now();\n\n    if (cache.has(key)) {\n      const cached = cache.get(key);\n\n      if (date - cached.date < maxAge) {\n        return cached.data;\n      }\n    }\n\n    // @ts-ignore\n    const data: ReturnType<T> = fn(...args);\n\n    cache.set(key, {\n      data,\n      date: Date.now(),\n    });\n\n    return data;\n  };\n}\n"],
+  "mappings": "AAgBO,SAAS,QACd,IACA;AAAA,EACE,SAAS,OAAO;AAAA,EAChB,WAAW,KAAK;AAAA,EAChB,QAAQ,oBAAI,IAAI;AAClB,IAAmC,CAAC,GACO;AAC3C,SAAO,SAAS,YAAY,MAAqB;AAC/C,UAAM,MAAM,SAAS,IAAI;AACzB,UAAM,OAAO,KAAK,IAAI;AAEtB,QAAI,MAAM,IAAI,GAAG,GAAG;AAClB,YAAM,SAAS,MAAM,IAAI,GAAG;AAE5B,UAAI,OAAO,OAAO,OAAO,QAAQ;AAC/B,eAAO,OAAO;AAAA,MAChB;AAAA,IACF;AAGA,UAAM,OAAsB,GAAG,GAAG,IAAI;AAEtC,UAAM,IAAI,KAAK;AAAA,MACb;AAAA,MACA,MAAM,KAAK,IAAI;AAAA,IACjB,CAAC;AAED,WAAO;AAAA,EACT;AACF;",
   "names": []
 }

package/utils/nextFrame.d.ts

@@ -1,7 +1,8 @@
 type Callback = (time?: DOMHighResTimeStamp) => any;
 /**
  * Wait for the next frame to execute a function.
- */
+ * @link https://js-toolkit.studiometa.dev/utils/nextFrame.html
+*/
 export declare function nextFrame(): Promise<DOMHighResTimeStamp>;
 export declare function nextFrame<T extends Callback>(callback?: T): Promise<ReturnType<T>>;
 export {};

package/utils/nextFrame.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../packages/js-toolkit/utils/nextFrame.ts"],
-  "sourcesContent": ["import { isFunction } from './is.js';\nimport { hasWindow } from './has.js';\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype Callback = (time?: DOMHighResTimeStamp) => any;\n\n/**\n * Wait for the next frame to execute a function.\n */\nexport function nextFrame(): Promise<DOMHighResTimeStamp>;\nexport function nextFrame<T extends Callback>(callback?: T): Promise<ReturnType<T>>;\nexport function nextFrame<T extends Callback>(callback?: T): Promise<ReturnType<T>> {\n  const fn = hasWindow() ? (window?.requestAnimationFrame ?? setTimeout) : setTimeout;\n  return new Promise((resolve) => {\n    fn((time) => resolve(isFunction(callback) ? callback(time) : time));\n  });\n}\n"],
-  "mappings": "AAAA,SAAS,kBAAkB;AAC3B,SAAS,iBAAiB;AAUnB,SAAS,UAA8B,UAAsC;AAClF,QAAM,KAAK,UAAU,IAAK,QAAQ,yBAAyB,aAAc;AACzE,SAAO,IAAI,QAAQ,CAAC,YAAY;AAC9B,OAAG,CAAC,SAAS,QAAQ,WAAW,QAAQ,IAAI,SAAS,IAAI,IAAI,IAAI,CAAC;AAAA,EACpE,CAAC;AACH;",
+  "sourcesContent": ["import { isFunction } from './is.js';\nimport { hasWindow } from './has.js';\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype Callback = (time?: DOMHighResTimeStamp) => any;\n\n/**\n * Wait for the next frame to execute a function.\n * @link https://js-toolkit.studiometa.dev/utils/nextFrame.html\n*/\nexport function nextFrame(): Promise<DOMHighResTimeStamp>;\nexport function nextFrame<T extends Callback>(callback?: T): Promise<ReturnType<T>>;\nexport function nextFrame<T extends Callback>(callback?: T): Promise<ReturnType<T>> {\n  const fn = hasWindow() ? (window?.requestAnimationFrame ?? setTimeout) : setTimeout;\n  return new Promise((resolve) => {\n    fn((time) => resolve(isFunction(callback) ? callback(time) : time));\n  });\n}\n"],
+  "mappings": "AAAA,SAAS,kBAAkB;AAC3B,SAAS,iBAAiB;AAWnB,SAAS,UAA8B,UAAsC;AAClF,QAAM,KAAK,UAAU,IAAK,QAAQ,yBAAyB,aAAc;AACzE,SAAO,IAAI,QAAQ,CAAC,YAAY;AAC9B,OAAG,CAAC,SAAS,QAAQ,WAAW,QAAQ,IAAI,SAAS,IAAI,IAAI,IAAI,CAAC;AAAA,EACpE,CAAC;AACH;",
   "names": []
 }

package/utils/nextMicrotask.d.ts

@@ -1,7 +1,8 @@
 type Callback = (...args: any[]) => any;
 /**
  * Wait for the next microtask.
- */
+ * @link https://js-toolkit.studiometa.dev/utils/nextMicrotask.html
+*/
 export declare function nextMicrotask(): Promise<void>;
 export declare function nextMicrotask<T extends Callback>(callback?: T): Promise<ReturnType<T>>;
 export {};

package/utils/nextMicrotask.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../packages/js-toolkit/utils/nextMicrotask.ts"],
-  "sourcesContent": ["import { isFunction } from './is.js';\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype Callback = (...args: any[]) => any;\n\n/**\n * Wait for the next microtask.\n */\nexport async function nextMicrotask(): Promise<void>;\nexport async function nextMicrotask<T extends Callback>(callback?: T): Promise<ReturnType<T>>;\nexport async function nextMicrotask<T extends Callback>(callback?: T): Promise<ReturnType<T>> {\n  return Promise.resolve().then(() => isFunction(callback) && callback());\n}\n"],
-  "mappings": "AAAA,SAAS,kBAAkB;AAU3B,eAAsB,cAAkC,UAAsC;AAC5F,SAAO,QAAQ,QAAQ,EAAE,KAAK,MAAM,WAAW,QAAQ,KAAK,SAAS,CAAC;AACxE;",
+  "sourcesContent": ["import { isFunction } from './is.js';\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype Callback = (...args: any[]) => any;\n\n/**\n * Wait for the next microtask.\n * @link https://js-toolkit.studiometa.dev/utils/nextMicrotask.html\n*/\nexport async function nextMicrotask(): Promise<void>;\nexport async function nextMicrotask<T extends Callback>(callback?: T): Promise<ReturnType<T>>;\nexport async function nextMicrotask<T extends Callback>(callback?: T): Promise<ReturnType<T>> {\n  return Promise.resolve().then(() => isFunction(callback) && callback());\n}\n"],
+  "mappings": "AAAA,SAAS,kBAAkB;AAW3B,eAAsB,cAAkC,UAAsC;AAC5F,SAAO,QAAQ,QAAQ,EAAE,KAAK,MAAM,WAAW,QAAQ,KAAK,SAAS,CAAC;AACxE;",
   "names": []
 }

package/utils/nextTick.d.ts

@@ -1,7 +1,8 @@
 type Callback = (...args: any[]) => any;
 /**
  * Wait for the next tick.
- */
+ * @link https://js-toolkit.studiometa.dev/utils/nextTick.html
+*/
 export declare function nextTick(): Promise<void>;
 export declare function nextTick<T extends Callback>(callback?: T): Promise<ReturnType<T>>;
 export {};

package/utils/nextTick.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../packages/js-toolkit/utils/nextTick.ts"],
-  "sourcesContent": ["import { isFunction } from './is.js';\nimport { wait } from './wait.js';\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype Callback = (...args: any[]) => any;\n\n/**\n * Wait for the next tick.\n */\nexport async function nextTick(): Promise<void>;\nexport async function nextTick<T extends Callback>(callback?: T): Promise<ReturnType<T>>;\nexport async function nextTick<T extends Callback>(callback?: T): Promise<ReturnType<T>> {\n  return wait().then(isFunction(callback) && (callback as ReturnType<T>));\n}\n"],
-  "mappings": "AAAA,SAAS,kBAAkB;AAC3B,SAAS,YAAY;AAUrB,eAAsB,SAA6B,UAAsC;AACvF,SAAO,KAAK,EAAE,KAAK,WAAW,QAAQ,KAAM,QAA0B;AACxE;",
+  "sourcesContent": ["import { isFunction } from './is.js';\nimport { wait } from './wait.js';\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype Callback = (...args: any[]) => any;\n\n/**\n * Wait for the next tick.\n * @link https://js-toolkit.studiometa.dev/utils/nextTick.html\n*/\nexport async function nextTick(): Promise<void>;\nexport async function nextTick<T extends Callback>(callback?: T): Promise<ReturnType<T>>;\nexport async function nextTick<T extends Callback>(callback?: T): Promise<ReturnType<T>> {\n  return wait().then(isFunction(callback) && (callback as ReturnType<T>));\n}\n"],
+  "mappings": "AAAA,SAAS,kBAAkB;AAC3B,SAAS,YAAY;AAWrB,eAAsB,SAA6B,UAAsC;AACvF,SAAO,KAAK,EAAE,KAAK,WAAW,QAAQ,KAAM,QAA0B;AACxE;",
   "names": []
 }

package/utils/noop.d.ts

@@ -1,7 +1,7 @@
 /**
  * No operation function.
  *
- * @returns {void}
+ * @return {void}
  */
 export declare function noop(): void;
 /**

package/utils/noop.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../packages/js-toolkit/utils/noop.ts"],
-  "sourcesContent": ["/**\n * No operation function.\n *\n * @returns {void}\n */\nexport function noop() {}\n\n/**\n * No operation function which return the given value unaltered.\n */\nexport function noopValue<T>(value: T): T {\n  return value;\n}\n"],
+  "sourcesContent": ["/**\n * No operation function.\n *\n * @return {void}\n */\nexport function noop() {}\n\n/**\n * No operation function which return the given value unaltered.\n */\nexport function noopValue<T>(value: T): T {\n  return value;\n}\n"],
   "mappings": "AAKO,SAAS,OAAO;AAAC;AAKjB,SAAS,UAAa,OAAa;AACxC,SAAO;AACT;",
   "names": []
 }

package/utils/object/getAllProperties.d.ts

@@ -6,6 +6,6 @@
  * @param {Array} [props=[]]
  *   The already existing properties.
  * @param {(name:string, proto:any) => boolean} testFn
- * @returns {Array<[string, Object]>} An array of properties and the prototype they belong to.
+ * @return {Array<[string, Object]>} An array of properties and the prototype they belong to.
  */
 export declare function getAllProperties(object: unknown, props?: Array<[string, unknown]>, testFn?: (name: string, proto: unknown) => boolean): Array<[string, unknown]>;

package/utils/object/getAllProperties.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../packages/js-toolkit/utils/object/getAllProperties.ts"],
-  "sourcesContent": ["import { isFunction } from '../is.js';\n\n/**\n * Gets all non-builtin properties up the prototype chain.\n *\n * @param {Object} object\n *   The object to get the propeties from.\n * @param {Array} [props=[]]\n *   The already existing properties.\n * @param {(name:string, proto:any) => boolean} testFn\n * @returns {Array<[string, Object]>} An array of properties and the prototype they belong to.\n */\nexport function getAllProperties(\n  object: unknown,\n  props: Array<[string, unknown]> = [],\n  testFn: (name: string, proto: unknown) => boolean = null,\n): Array<[string, unknown]> {\n  const proto = Object.getPrototypeOf(object);\n\n  if (proto === Object.prototype || proto === null) {\n    return props;\n  }\n\n  let foundProps = Object.getOwnPropertyNames(proto);\n\n  if (isFunction(testFn)) {\n    foundProps = foundProps.filter((name) => testFn(name, proto));\n  }\n\n  const formatedProps = foundProps\n    .map<[string, unknown]>((name) => [name, proto])\n    .reduce<Array<[string, unknown]>>((acc, val) => [...acc, val], props);\n\n  return getAllProperties(proto, formatedProps, testFn);\n}\n"],
+  "sourcesContent": ["import { isFunction } from '../is.js';\n\n/**\n * Gets all non-builtin properties up the prototype chain.\n *\n * @param {Object} object\n *   The object to get the propeties from.\n * @param {Array} [props=[]]\n *   The already existing properties.\n * @param {(name:string, proto:any) => boolean} testFn\n * @return {Array<[string, Object]>} An array of properties and the prototype they belong to.\n */\nexport function getAllProperties(\n  object: unknown,\n  props: Array<[string, unknown]> = [],\n  testFn: (name: string, proto: unknown) => boolean = null,\n): Array<[string, unknown]> {\n  const proto = Object.getPrototypeOf(object);\n\n  if (proto === Object.prototype || proto === null) {\n    return props;\n  }\n\n  let foundProps = Object.getOwnPropertyNames(proto);\n\n  if (isFunction(testFn)) {\n    foundProps = foundProps.filter((name) => testFn(name, proto));\n  }\n\n  const formatedProps = foundProps\n    .map<[string, unknown]>((name) => [name, proto])\n    .reduce<Array<[string, unknown]>>((acc, val) => [...acc, val], props);\n\n  return getAllProperties(proto, formatedProps, testFn);\n}\n"],
   "mappings": "AAAA,SAAS,kBAAkB;AAYpB,SAAS,iBACd,QACA,QAAkC,CAAC,GACnC,SAAoD,MAC1B;AAC1B,QAAM,QAAQ,OAAO,eAAe,MAAM;AAE1C,MAAI,UAAU,OAAO,aAAa,UAAU,MAAM;AAChD,WAAO;AAAA,EACT;AAEA,MAAI,aAAa,OAAO,oBAAoB,KAAK;AAEjD,MAAI,WAAW,MAAM,GAAG;AACtB,iBAAa,WAAW,OAAO,CAAC,SAAS,OAAO,MAAM,KAAK,CAAC;AAAA,EAC9D;AAEA,QAAM,gBAAgB,WACnB,IAAuB,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAC9C,OAAiC,CAAC,KAAK,QAAQ,CAAC,GAAG,KAAK,GAAG,GAAG,KAAK;AAEtE,SAAO,iBAAiB,OAAO,eAAe,MAAM;AACtD;",
   "names": []
 }

package/utils/random.d.ts

@@ -1,23 +1,26 @@
 /**
  * Get a random number between given bounds.
- * @param   {number} a   First bound.
- * @param   {number} [b] Second bound, defaults to 0.
- * @returns {number} A number between `a` and `b`.
- */
+ * @param  {number} a   First bound.
+ * @param  {number} [b] Second bound, defaults to 0.
+ * @return {number} A number between `a` and `b`.
+ * @link https://js-toolkit.studiometa.dev/utils/random.html
+*/
 export declare function random(a: number, b?: number): number;
 /**
  * Get a random integer between bounds
  *
  * @param {number} a First bound.
  * @param {number} b Second bound.
- * @returns {number} An integer between `a` and `b`;
- */
+ * @return {number} An integer between `a` and `b`;
+ * @link https://js-toolkit.studiometa.dev/utils/randomInt.html
+*/
 export declare function randomInt(a: number, b?: number): number;
 /**
  * Get a random item of an array or a random character of a string
  *
  * @param {T[] | string} items Array or string
- * @returns {T | undefined}
+ * @return {T | undefined}
  * @throws {Error} Throws an error if `items` is not an array or a string.
- */
+ * @link https://js-toolkit.studiometa.dev/utils/randomItem.html
+*/
 export declare function randomItem<T>(items: T[] | string): T | string | undefined;

package/utils/random.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../packages/js-toolkit/utils/random.ts"],
-  "sourcesContent": ["import { isArray, isString } from './is.js';\n\n/**\n * Get a random number between given bounds.\n * @param   {number} a   First bound.\n * @param   {number} [b] Second bound, defaults to 0.\n * @returns {number} A number between `a` and `b`.\n */\nexport function random(a: number, b = 0): number {\n  return Math.random() * (b - a) + a;\n}\n\n/**\n * Get a random integer between bounds\n *\n * @param {number} a First bound.\n * @param {number} b Second bound.\n * @returns {number} An integer between `a` and `b`;\n */\nexport function randomInt(a: number, b = 0): number {\n  return Math.round(random(a, b));\n}\n\n/**\n * Get a random item of an array or a random character of a string\n *\n * @param {T[] | string} items Array or string\n * @returns {T | undefined}\n * @throws {Error} Throws an error if `items` is not an array or a string.\n */\nexport function randomItem<T>(items: T[] | string): T | string | undefined {\n  if (!isArray(items) && !isString(items)) {\n    throw new Error('randomItem() expects an array or a string as argument.');\n  }\n  return items.length > 0 ? items[randomInt(items.length - 1)] : undefined;\n}\n"],
-  "mappings": "AAAA,SAAS,SAAS,gBAAgB;AAQ3B,SAAS,OAAO,GAAW,IAAI,GAAW;AAC/C,SAAO,KAAK,OAAO,KAAK,IAAI,KAAK;AACnC;AASO,SAAS,UAAU,GAAW,IAAI,GAAW;AAClD,SAAO,KAAK,MAAM,OAAO,GAAG,CAAC,CAAC;AAChC;AASO,SAAS,WAAc,OAA6C;AACzE,MAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,SAAS,KAAK,GAAG;AACvC,UAAM,IAAI,MAAM,wDAAwD;AAAA,EAC1E;AACA,SAAO,MAAM,SAAS,IAAI,MAAM,UAAU,MAAM,SAAS,CAAC,CAAC,IAAI;AACjE;",
+  "sourcesContent": ["import { isArray, isString } from './is.js';\n\n/**\n * Get a random number between given bounds.\n * @param  {number} a   First bound.\n * @param  {number} [b] Second bound, defaults to 0.\n * @return {number} A number between `a` and `b`.\n * @link https://js-toolkit.studiometa.dev/utils/random.html\n*/\nexport function random(a: number, b = 0): number {\n  return Math.random() * (b - a) + a;\n}\n\n/**\n * Get a random integer between bounds\n *\n * @param {number} a First bound.\n * @param {number} b Second bound.\n * @return {number} An integer between `a` and `b`;\n * @link https://js-toolkit.studiometa.dev/utils/randomInt.html\n*/\nexport function randomInt(a: number, b = 0): number {\n  return Math.round(random(a, b));\n}\n\n/**\n * Get a random item of an array or a random character of a string\n *\n * @param {T[] | string} items Array or string\n * @return {T | undefined}\n * @throws {Error} Throws an error if `items` is not an array or a string.\n * @link https://js-toolkit.studiometa.dev/utils/randomItem.html\n*/\nexport function randomItem<T>(items: T[] | string): T | string | undefined {\n  if (!isArray(items) && !isString(items)) {\n    throw new Error('randomItem() expects an array or a string as argument.');\n  }\n  return items.length > 0 ? items[randomInt(items.length - 1)] : undefined;\n}\n"],
+  "mappings": "AAAA,SAAS,SAAS,gBAAgB;AAS3B,SAAS,OAAO,GAAW,IAAI,GAAW;AAC/C,SAAO,KAAK,OAAO,KAAK,IAAI,KAAK;AACnC;AAUO,SAAS,UAAU,GAAW,IAAI,GAAW;AAClD,SAAO,KAAK,MAAM,OAAO,GAAG,CAAC,CAAC;AAChC;AAUO,SAAS,WAAc,OAA6C;AACzE,MAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,SAAS,KAAK,GAAG;AACvC,UAAM,IAAI,MAAM,wDAAwD;AAAA,EAC1E;AACA,SAAO,MAAM,SAAS,IAAI,MAAM,UAAU,MAAM,SAAS,CAAC,CAAC,IAAI;AACjE;",
   "names": []
 }

package/utils/scheduler.d.ts

@@ -4,7 +4,12 @@
 declare function getScheduler<T extends string>(steps: T[]): Record<T, (fn: () => unknown) => void>;
 /**
  * Use a scheduler based on the given steps.
- */
+ * @link https://js-toolkit.studiometa.dev/utils/useScheduler.html
+*/
 export declare function useScheduler<T extends string>(steps?: T[]): ReturnType<typeof getScheduler<T>>;
+/**
+ * DOM-oriented scheduler using read/write/afterWrite steps.
+ * @link https://js-toolkit.studiometa.dev/utils/domScheduler.html
+*/
 export declare const domScheduler: Record<"read" | "write" | "afterWrite", (fn: () => unknown) => void>;
 export {};

package/utils/scheduler.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../packages/js-toolkit/utils/scheduler.ts"],
-  "sourcesContent": ["/**\n * Generate a scheduler.\n */\nfunction getScheduler<T extends string>(steps: T[]): Record<T, (fn: () => unknown) => void> {\n  const stepsFns = {} as Record<T, Array<() => void>>;\n  const api = {} as Record<T, (fn: () => void) => void>;\n\n  let isScheduled = false;\n\n  const resolvedPromise = Promise.resolve();\n\n  /**\n   * Execute the given list of tasks.\n   */\n  function run(tasks: Array<() => void>) {\n    let task;\n    // eslint-disable-next-line no-cond-assign\n    while ((task = tasks.shift())) {\n      task();\n    }\n  }\n\n  /**\n   * Flush registered tasks and schedule the next run if needed.\n   */\n  function flush() {\n    for (const step of steps) {\n      run(stepsFns[step]);\n    }\n    isScheduled = false;\n\n    if (steps.reduce((length, step) => length + stepsFns[step].length, 0) > 0) {\n      // eslint-disable-next-line @typescript-eslint/no-use-before-define, no-use-before-define\n      scheduleFlush();\n    }\n  }\n\n  /**\n   * Schedule the next flush of tasks.\n   */\n  function scheduleFlush() {\n    if (isScheduled) {\n      return;\n    }\n\n    isScheduled = true;\n    resolvedPromise.then(flush);\n  }\n\n  for (const step of steps) {\n    stepsFns[step] = [];\n    api[step] = function add(fn) {\n      stepsFns[step].push(fn);\n      scheduleFlush();\n    };\n  }\n\n  return api;\n}\n\nconst instances = new Map();\n\nconst domSchedulerSteps = ['read', 'write', 'afterWrite'];\n\n/**\n * Use a scheduler based on the given steps.\n */\nexport function useScheduler<T extends string>(\n  steps: T[] = domSchedulerSteps as T[],\n): ReturnType<typeof getScheduler<T>> {\n  const key = steps.join('-');\n\n  if (instances.has(key)) {\n    return instances.get(key);\n  }\n\n  const scheduler = getScheduler(steps);\n  instances.set(key, scheduler);\n\n  return scheduler;\n}\n\nexport const domScheduler = useScheduler(domSchedulerSteps as ['read', 'write', 'afterWrite']);\n"],
-  "mappings": "AAGA,SAAS,aAA+B,OAAoD;AAC1F,QAAM,WAAW,CAAC;AAClB,QAAM,MAAM,CAAC;AAEb,MAAI,cAAc;AAElB,QAAM,kBAAkB,QAAQ,QAAQ;AAKxC,WAAS,IAAI,OAA0B;AACrC,QAAI;AAEJ,WAAQ,OAAO,MAAM,MAAM,GAAI;AAC7B,WAAK;AAAA,IACP;AAAA,EACF;AAKA,WAAS,QAAQ;AACf,eAAW,QAAQ,OAAO;AACxB,UAAI,SAAS,IAAI,CAAC;AAAA,IACpB;AACA,kBAAc;AAEd,QAAI,MAAM,OAAO,CAAC,QAAQ,SAAS,SAAS,SAAS,IAAI,EAAE,QAAQ,CAAC,IAAI,GAAG;AAEzE,oBAAc;AAAA,IAChB;AAAA,EACF;AAKA,WAAS,gBAAgB;AACvB,QAAI,aAAa;AACf;AAAA,IACF;AAEA,kBAAc;AACd,oBAAgB,KAAK,KAAK;AAAA,EAC5B;AAEA,aAAW,QAAQ,OAAO;AACxB,aAAS,IAAI,IAAI,CAAC;AAClB,QAAI,IAAI,IAAI,SAAS,IAAI,IAAI;AAC3B,eAAS,IAAI,EAAE,KAAK,EAAE;AACtB,oBAAc;AAAA,IAChB;AAAA,EACF;AAEA,SAAO;AACT;AAEA,MAAM,YAAY,oBAAI,IAAI;AAE1B,MAAM,oBAAoB,CAAC,QAAQ,SAAS,YAAY;AAKjD,SAAS,aACd,QAAa,mBACuB;AACpC,QAAM,MAAM,MAAM,KAAK,GAAG;AAE1B,MAAI,UAAU,IAAI,GAAG,GAAG;AACtB,WAAO,UAAU,IAAI,GAAG;AAAA,EAC1B;AAEA,QAAM,YAAY,aAAa,KAAK;AACpC,YAAU,IAAI,KAAK,SAAS;AAE5B,SAAO;AACT;AAEO,MAAM,eAAe,aAAa,iBAAoD;",
+  "sourcesContent": ["/**\n * Generate a scheduler.\n */\nfunction getScheduler<T extends string>(steps: T[]): Record<T, (fn: () => unknown) => void> {\n  const stepsFns = {} as Record<T, Array<() => void>>;\n  const api = {} as Record<T, (fn: () => void) => void>;\n\n  let isScheduled = false;\n\n  const resolvedPromise = Promise.resolve();\n\n  /**\n   * Execute the given list of tasks.\n   */\n  function run(tasks: Array<() => void>) {\n    let task;\n    // eslint-disable-next-line no-cond-assign\n    while ((task = tasks.shift())) {\n      task();\n    }\n  }\n\n  /**\n   * Flush registered tasks and schedule the next run if needed.\n   */\n  function flush() {\n    for (const step of steps) {\n      run(stepsFns[step]);\n    }\n    isScheduled = false;\n\n    if (steps.reduce((length, step) => length + stepsFns[step].length, 0) > 0) {\n      // eslint-disable-next-line @typescript-eslint/no-use-before-define, no-use-before-define\n      scheduleFlush();\n    }\n  }\n\n  /**\n   * Schedule the next flush of tasks.\n   */\n  function scheduleFlush() {\n    if (isScheduled) {\n      return;\n    }\n\n    isScheduled = true;\n    resolvedPromise.then(flush);\n  }\n\n  for (const step of steps) {\n    stepsFns[step] = [];\n    api[step] = function add(fn) {\n      stepsFns[step].push(fn);\n      scheduleFlush();\n    };\n  }\n\n  return api;\n}\n\nconst instances = new Map();\n\nconst domSchedulerSteps = ['read', 'write', 'afterWrite'];\n\n/**\n * Use a scheduler based on the given steps.\n * @link https://js-toolkit.studiometa.dev/utils/useScheduler.html\n*/\nexport function useScheduler<T extends string>(\n  steps: T[] = domSchedulerSteps as T[],\n): ReturnType<typeof getScheduler<T>> {\n  const key = steps.join('-');\n\n  if (instances.has(key)) {\n    return instances.get(key);\n  }\n\n  const scheduler = getScheduler(steps);\n  instances.set(key, scheduler);\n\n  return scheduler;\n}\n\n/**\n * DOM-oriented scheduler using read/write/afterWrite steps.\n * @link https://js-toolkit.studiometa.dev/utils/domScheduler.html\n*/\nexport const domScheduler = useScheduler(domSchedulerSteps as ['read', 'write', 'afterWrite']);\n"],
+  "mappings": "AAGA,SAAS,aAA+B,OAAoD;AAC1F,QAAM,WAAW,CAAC;AAClB,QAAM,MAAM,CAAC;AAEb,MAAI,cAAc;AAElB,QAAM,kBAAkB,QAAQ,QAAQ;AAKxC,WAAS,IAAI,OAA0B;AACrC,QAAI;AAEJ,WAAQ,OAAO,MAAM,MAAM,GAAI;AAC7B,WAAK;AAAA,IACP;AAAA,EACF;AAKA,WAAS,QAAQ;AACf,eAAW,QAAQ,OAAO;AACxB,UAAI,SAAS,IAAI,CAAC;AAAA,IACpB;AACA,kBAAc;AAEd,QAAI,MAAM,OAAO,CAAC,QAAQ,SAAS,SAAS,SAAS,IAAI,EAAE,QAAQ,CAAC,IAAI,GAAG;AAEzE,oBAAc;AAAA,IAChB;AAAA,EACF;AAKA,WAAS,gBAAgB;AACvB,QAAI,aAAa;AACf;AAAA,IACF;AAEA,kBAAc;AACd,oBAAgB,KAAK,KAAK;AAAA,EAC5B;AAEA,aAAW,QAAQ,OAAO;AACxB,aAAS,IAAI,IAAI,CAAC;AAClB,QAAI,IAAI,IAAI,SAAS,IAAI,IAAI;AAC3B,eAAS,IAAI,EAAE,KAAK,EAAE;AACtB,oBAAc;AAAA,IAChB;AAAA,EACF;AAEA,SAAO;AACT;AAEA,MAAM,YAAY,oBAAI,IAAI;AAE1B,MAAM,oBAAoB,CAAC,QAAQ,SAAS,YAAY;AAMjD,SAAS,aACd,QAAa,mBACuB;AACpC,QAAM,MAAM,MAAM,KAAK,GAAG;AAE1B,MAAI,UAAU,IAAI,GAAG,GAAG;AACtB,WAAO,UAAU,IAAI,GAAG;AAAA,EAC1B;AAEA,QAAM,YAAY,aAAa,KAAK;AACpC,YAAU,IAAI,KAAK,SAAS;AAE5B,SAAO;AACT;AAMO,MAAM,eAAe,aAAa,iBAAoD;",
   "names": []
 }

package/utils/scrollTo.d.ts

@@ -21,8 +21,9 @@ export interface ScrollToOptions extends TweenOptions {
 /**
  * Scroll to an element.
  *
- * @returns {Promise<ScrollPosition>} A promising resolving with the scroll position.
- */
+ * @return {Promise<ScrollPosition>} A promising resolving with the scroll position.
+ * @link https://js-toolkit.studiometa.dev/utils/scrollTo.html
+*/
 export declare function scrollTo(target: string | HTMLElement | number | Partial<ScrollPosition>, { rootElement, axis, offset, ...tweenOptions }?: ScrollToOptions): Promise<ScrollPosition>;
 export declare namespace scrollTo {
     var axis: {

package/utils/scrollTo.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../packages/js-toolkit/utils/scrollTo.ts"],
-  "sourcesContent": ["import { tween } from './tween.js';\nimport type { TweenOptions } from './tween.js';\nimport { isString, isNumber, isFunction, isDefined } from './is.js';\nimport { lerp } from './math/index.js';\n\nexport interface ScrollPosition {\n  left: number;\n  top: number;\n}\n\nexport type ScrollTarget = string | HTMLElement | number | Partial<ScrollPosition>;\n\nexport interface ScrollToOptions extends TweenOptions {\n  /**\n   * Root element that will be scrolled.\n   */\n  rootElement?: HTMLElement | typeof window;\n  /**\n   * Scroll direction.\n   */\n  axis?: (typeof scrollTo.axis)[keyof typeof scrollTo.axis];\n  /**\n   * Distance from the target.\n   */\n  offset?: number;\n}\n\nconst xAxis = Symbol(0);\nconst yAxis = Symbol(1);\nconst bothAxis = Symbol(2);\n\nfunction isHtmlElement(rootElement: ScrollToOptions['rootElement']): rootElement is HTMLElement {\n  return rootElement instanceof HTMLElement;\n}\n\n/**\n * Get the current root element or window scroll position.\n */\nfunction getCurrentScrollPosition(rootElement: ScrollToOptions['rootElement']): ScrollPosition {\n  return {\n    left: isHtmlElement(rootElement) ? rootElement.scrollTop : rootElement.scrollX,\n    top: isHtmlElement(rootElement) ? rootElement.scrollLeft : rootElement.scrollY,\n  };\n}\n\n/**\n * Get the maximum scroll position values.\n */\nfunction getMaxScrollPosition(rootElement?: ScrollToOptions['rootElement']): ScrollPosition {\n  return {\n    left: isHtmlElement(rootElement)\n      ? rootElement.scrollWidth - rootElement.offsetWidth\n      : document.documentElement.scrollWidth - window.innerWidth,\n    top: isHtmlElement(rootElement)\n      ? rootElement.scrollHeight - rootElement.offsetHeight\n      : document.documentElement.scrollHeight - window.innerHeight,\n  };\n}\n\n/**\n * Get the target scroll position.\n */\nfunction getTargetScrollPosition(\n  initialScrollPosition: ScrollPosition,\n  maxScrollPosition: ScrollPosition,\n  target: ScrollTarget,\n  axis: ScrollToOptions['axis'],\n  offset: number,\n): ScrollPosition {\n  let { top, left } = initialScrollPosition;\n\n  if (target instanceof HTMLElement || isString(target)) {\n    const targetElement = target instanceof HTMLElement ? target : document.querySelector(target);\n\n    if (!targetElement) {\n      return { top, left };\n    }\n\n    const sizes = targetElement.getBoundingClientRect();\n    const styles = getComputedStyle(targetElement);\n    const scrollMargin = {\n      left: Number.parseInt(styles.scrollMarginLeft || '0', 10),\n      top: Number.parseInt(styles.scrollMarginTop || '0', 10),\n    };\n\n    // Set the scroll position of the target element.\n    left = sizes.left + initialScrollPosition.left - scrollMargin.left;\n    top = sizes.top + initialScrollPosition.top - scrollMargin.top;\n  } else if (isNumber(target)) {\n    left = target;\n    top = target;\n  } else {\n    left = target.left ?? left;\n    top = target.top ?? top;\n  }\n\n  left -= offset;\n  top -= offset;\n\n  if (axis !== bothAxis) {\n    if (axis !== xAxis && !isDefined((target as Partial<ScrollPosition>).left)) {\n      left = initialScrollPosition.left;\n    }\n\n    if (axis !== yAxis) {\n      top = initialScrollPosition.top;\n    }\n  }\n\n  return {\n    left: Math.min(left, maxScrollPosition.left),\n    top: Math.min(top, maxScrollPosition.top),\n  };\n}\n\n/**\n * Scroll to an element.\n *\n * @returns {Promise<ScrollPosition>} A promising resolving with the scroll position.\n */\nexport function scrollTo(\n  target: string | HTMLElement | number | Partial<ScrollPosition>,\n  { rootElement = window, axis = yAxis, offset = 0, ...tweenOptions }: ScrollToOptions = {},\n): Promise<ScrollPosition> {\n  const initialScrollPosition = getCurrentScrollPosition(rootElement);\n  const maxScrollPosition = getMaxScrollPosition(rootElement);\n  const targetScrollPosition = getTargetScrollPosition(\n    initialScrollPosition,\n    maxScrollPosition,\n    target,\n    axis,\n    offset,\n  );\n\n  return new Promise((resolve) => {\n    function eventHandler() {\n      /* eslint-disable @typescript-eslint/no-use-before-define */\n      tw.pause();\n      stop();\n      /* eslint-enable @typescript-eslint/no-use-before-define */\n    }\n\n    function stop() {\n      rootElement.removeEventListener('wheel', eventHandler);\n      rootElement.removeEventListener('touchmove', eventHandler);\n\n      // Resolve the promise on animation finish.\n      resolve(getCurrentScrollPosition(rootElement));\n    }\n\n    // Setup tween.\n    const tw = tween(\n      (progress) => {\n        rootElement.scrollTo({\n          left: lerp(initialScrollPosition.left, targetScrollPosition.left, progress),\n          top: lerp(initialScrollPosition.top, targetScrollPosition.top, progress),\n          behavior: 'instant',\n        });\n      },\n      {\n        smooth: 0.2,\n        ...tweenOptions,\n        onFinish(progress) {\n          if (isFunction(tweenOptions.onFinish)) {\n            tweenOptions.onFinish(progress);\n          }\n\n          stop();\n        },\n      },\n    );\n\n    rootElement.addEventListener('wheel', eventHandler, { passive: true });\n    rootElement.addEventListener('touchmove', eventHandler, { passive: true });\n    tw.start();\n  });\n}\n\nscrollTo.axis = {\n  x: xAxis,\n  y: yAxis,\n  both: bothAxis,\n};\n"],
-  "mappings": "AAAA,SAAS,aAAa;AAEtB,SAAS,UAAU,UAAU,YAAY,iBAAiB;AAC1D,SAAS,YAAY;AAwBrB,MAAM,QAAQ,OAAO,CAAC;AACtB,MAAM,QAAQ,OAAO,CAAC;AACtB,MAAM,WAAW,OAAO,CAAC;AAEzB,SAAS,cAAc,aAAyE;AAC9F,SAAO,uBAAuB;AAChC;AAKA,SAAS,yBAAyB,aAA6D;AAC7F,SAAO;AAAA,IACL,MAAM,cAAc,WAAW,IAAI,YAAY,YAAY,YAAY;AAAA,IACvE,KAAK,cAAc,WAAW,IAAI,YAAY,aAAa,YAAY;AAAA,EACzE;AACF;AAKA,SAAS,qBAAqB,aAA8D;AAC1F,SAAO;AAAA,IACL,MAAM,cAAc,WAAW,IAC3B,YAAY,cAAc,YAAY,cACtC,SAAS,gBAAgB,cAAc,OAAO;AAAA,IAClD,KAAK,cAAc,WAAW,IAC1B,YAAY,eAAe,YAAY,eACvC,SAAS,gBAAgB,eAAe,OAAO;AAAA,EACrD;AACF;AAKA,SAAS,wBACP,uBACA,mBACA,QACA,MACA,QACgB;AAChB,MAAI,EAAE,KAAK,KAAK,IAAI;AAEpB,MAAI,kBAAkB,eAAe,SAAS,MAAM,GAAG;AACrD,UAAM,gBAAgB,kBAAkB,cAAc,SAAS,SAAS,cAAc,MAAM;AAE5F,QAAI,CAAC,eAAe;AAClB,aAAO,EAAE,KAAK,KAAK;AAAA,IACrB;AAEA,UAAM,QAAQ,cAAc,sBAAsB;AAClD,UAAM,SAAS,iBAAiB,aAAa;AAC7C,UAAM,eAAe;AAAA,MACnB,MAAM,OAAO,SAAS,OAAO,oBAAoB,KAAK,EAAE;AAAA,MACxD,KAAK,OAAO,SAAS,OAAO,mBAAmB,KAAK,EAAE;AAAA,IACxD;AAGA,WAAO,MAAM,OAAO,sBAAsB,OAAO,aAAa;AAC9D,UAAM,MAAM,MAAM,sBAAsB,MAAM,aAAa;AAAA,EAC7D,WAAW,SAAS,MAAM,GAAG;AAC3B,WAAO;AACP,UAAM;AAAA,EACR,OAAO;AACL,WAAO,OAAO,QAAQ;AACtB,UAAM,OAAO,OAAO;AAAA,EACtB;AAEA,UAAQ;AACR,SAAO;AAEP,MAAI,SAAS,UAAU;AACrB,QAAI,SAAS,SAAS,CAAC,UAAW,OAAmC,IAAI,GAAG;AAC1E,aAAO,sBAAsB;AAAA,IAC/B;AAEA,QAAI,SAAS,OAAO;AAClB,YAAM,sBAAsB;AAAA,IAC9B;AAAA,EACF;AAEA,SAAO;AAAA,IACL,MAAM,KAAK,IAAI,MAAM,kBAAkB,IAAI;AAAA,IAC3C,KAAK,KAAK,IAAI,KAAK,kBAAkB,GAAG;AAAA,EAC1C;AACF;AAOO,SAAS,SACd,QACA,EAAE,cAAc,QAAQ,OAAO,OAAO,SAAS,GAAG,GAAG,aAAa,IAAqB,CAAC,GAC/D;AACzB,QAAM,wBAAwB,yBAAyB,WAAW;AAClE,QAAM,oBAAoB,qBAAqB,WAAW;AAC1D,QAAM,uBAAuB;AAAA,IAC3B;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAEA,SAAO,IAAI,QAAQ,CAAC,YAAY;AAC9B,aAAS,eAAe;AAEtB,SAAG,MAAM;AACT,WAAK;AAAA,IAEP;AAEA,aAAS,OAAO;AACd,kBAAY,oBAAoB,SAAS,YAAY;AACrD,kBAAY,oBAAoB,aAAa,YAAY;AAGzD,cAAQ,yBAAyB,WAAW,CAAC;AAAA,IAC/C;AAGA,UAAM,KAAK;AAAA,MACT,CAAC,aAAa;AACZ,oBAAY,SAAS;AAAA,UACnB,MAAM,KAAK,sBAAsB,MAAM,qBAAqB,MAAM,QAAQ;AAAA,UAC1E,KAAK,KAAK,sBAAsB,KAAK,qBAAqB,KAAK,QAAQ;AAAA,UACvE,UAAU;AAAA,QACZ,CAAC;AAAA,MACH;AAAA,MACA;AAAA,QACE,QAAQ;AAAA,QACR,GAAG;AAAA,QACH,SAAS,UAAU;AACjB,cAAI,WAAW,aAAa,QAAQ,GAAG;AACrC,yBAAa,SAAS,QAAQ;AAAA,UAChC;AAEA,eAAK;AAAA,QACP;AAAA,MACF;AAAA,IACF;AAEA,gBAAY,iBAAiB,SAAS,cAAc,EAAE,SAAS,KAAK,CAAC;AACrE,gBAAY,iBAAiB,aAAa,cAAc,EAAE,SAAS,KAAK,CAAC;AACzE,OAAG,MAAM;AAAA,EACX,CAAC;AACH;AAEA,SAAS,OAAO;AAAA,EACd,GAAG;AAAA,EACH,GAAG;AAAA,EACH,MAAM;AACR;",
+  "sourcesContent": ["import { tween } from './tween.js';\nimport type { TweenOptions } from './tween.js';\nimport { isString, isNumber, isFunction, isDefined } from './is.js';\nimport { lerp } from './math/index.js';\n\nexport interface ScrollPosition {\n  left: number;\n  top: number;\n}\n\nexport type ScrollTarget = string | HTMLElement | number | Partial<ScrollPosition>;\n\nexport interface ScrollToOptions extends TweenOptions {\n  /**\n   * Root element that will be scrolled.\n   */\n  rootElement?: HTMLElement | typeof window;\n  /**\n   * Scroll direction.\n   */\n  axis?: (typeof scrollTo.axis)[keyof typeof scrollTo.axis];\n  /**\n   * Distance from the target.\n   */\n  offset?: number;\n}\n\nconst xAxis = Symbol(0);\nconst yAxis = Symbol(1);\nconst bothAxis = Symbol(2);\n\nfunction isHtmlElement(rootElement: ScrollToOptions['rootElement']): rootElement is HTMLElement {\n  return rootElement instanceof HTMLElement;\n}\n\n/**\n * Get the current root element or window scroll position.\n */\nfunction getCurrentScrollPosition(rootElement: ScrollToOptions['rootElement']): ScrollPosition {\n  return {\n    left: isHtmlElement(rootElement) ? rootElement.scrollTop : rootElement.scrollX,\n    top: isHtmlElement(rootElement) ? rootElement.scrollLeft : rootElement.scrollY,\n  };\n}\n\n/**\n * Get the maximum scroll position values.\n */\nfunction getMaxScrollPosition(rootElement?: ScrollToOptions['rootElement']): ScrollPosition {\n  return {\n    left: isHtmlElement(rootElement)\n      ? rootElement.scrollWidth - rootElement.offsetWidth\n      : document.documentElement.scrollWidth - window.innerWidth,\n    top: isHtmlElement(rootElement)\n      ? rootElement.scrollHeight - rootElement.offsetHeight\n      : document.documentElement.scrollHeight - window.innerHeight,\n  };\n}\n\n/**\n * Get the target scroll position.\n */\nfunction getTargetScrollPosition(\n  initialScrollPosition: ScrollPosition,\n  maxScrollPosition: ScrollPosition,\n  target: ScrollTarget,\n  axis: ScrollToOptions['axis'],\n  offset: number,\n): ScrollPosition {\n  let { top, left } = initialScrollPosition;\n\n  if (target instanceof HTMLElement || isString(target)) {\n    const targetElement = target instanceof HTMLElement ? target : document.querySelector(target);\n\n    if (!targetElement) {\n      return { top, left };\n    }\n\n    const sizes = targetElement.getBoundingClientRect();\n    const styles = getComputedStyle(targetElement);\n    const scrollMargin = {\n      left: Number.parseInt(styles.scrollMarginLeft || '0', 10),\n      top: Number.parseInt(styles.scrollMarginTop || '0', 10),\n    };\n\n    // Set the scroll position of the target element.\n    left = sizes.left + initialScrollPosition.left - scrollMargin.left;\n    top = sizes.top + initialScrollPosition.top - scrollMargin.top;\n  } else if (isNumber(target)) {\n    left = target;\n    top = target;\n  } else {\n    left = target.left ?? left;\n    top = target.top ?? top;\n  }\n\n  left -= offset;\n  top -= offset;\n\n  if (axis !== bothAxis) {\n    if (axis !== xAxis && !isDefined((target as Partial<ScrollPosition>).left)) {\n      left = initialScrollPosition.left;\n    }\n\n    if (axis !== yAxis) {\n      top = initialScrollPosition.top;\n    }\n  }\n\n  return {\n    left: Math.min(left, maxScrollPosition.left),\n    top: Math.min(top, maxScrollPosition.top),\n  };\n}\n\n/**\n * Scroll to an element.\n *\n * @return {Promise<ScrollPosition>} A promising resolving with the scroll position.\n * @link https://js-toolkit.studiometa.dev/utils/scrollTo.html\n*/\nexport function scrollTo(\n  target: string | HTMLElement | number | Partial<ScrollPosition>,\n  { rootElement = window, axis = yAxis, offset = 0, ...tweenOptions }: ScrollToOptions = {},\n): Promise<ScrollPosition> {\n  const initialScrollPosition = getCurrentScrollPosition(rootElement);\n  const maxScrollPosition = getMaxScrollPosition(rootElement);\n  const targetScrollPosition = getTargetScrollPosition(\n    initialScrollPosition,\n    maxScrollPosition,\n    target,\n    axis,\n    offset,\n  );\n\n  return new Promise((resolve) => {\n    function eventHandler() {\n      /* eslint-disable @typescript-eslint/no-use-before-define */\n      tw.pause();\n      stop();\n      /* eslint-enable @typescript-eslint/no-use-before-define */\n    }\n\n    function stop() {\n      rootElement.removeEventListener('wheel', eventHandler);\n      rootElement.removeEventListener('touchmove', eventHandler);\n\n      // Resolve the promise on animation finish.\n      resolve(getCurrentScrollPosition(rootElement));\n    }\n\n    // Setup tween.\n    const tw = tween(\n      (progress) => {\n        rootElement.scrollTo({\n          left: lerp(initialScrollPosition.left, targetScrollPosition.left, progress),\n          top: lerp(initialScrollPosition.top, targetScrollPosition.top, progress),\n          behavior: 'instant',\n        });\n      },\n      {\n        smooth: 0.2,\n        ...tweenOptions,\n        onFinish(progress) {\n          if (isFunction(tweenOptions.onFinish)) {\n            tweenOptions.onFinish(progress);\n          }\n\n          stop();\n        },\n      },\n    );\n\n    rootElement.addEventListener('wheel', eventHandler, { passive: true });\n    rootElement.addEventListener('touchmove', eventHandler, { passive: true });\n    tw.start();\n  });\n}\n\nscrollTo.axis = {\n  x: xAxis,\n  y: yAxis,\n  both: bothAxis,\n};\n"],
+  "mappings": "AAAA,SAAS,aAAa;AAEtB,SAAS,UAAU,UAAU,YAAY,iBAAiB;AAC1D,SAAS,YAAY;AAwBrB,MAAM,QAAQ,OAAO,CAAC;AACtB,MAAM,QAAQ,OAAO,CAAC;AACtB,MAAM,WAAW,OAAO,CAAC;AAEzB,SAAS,cAAc,aAAyE;AAC9F,SAAO,uBAAuB;AAChC;AAKA,SAAS,yBAAyB,aAA6D;AAC7F,SAAO;AAAA,IACL,MAAM,cAAc,WAAW,IAAI,YAAY,YAAY,YAAY;AAAA,IACvE,KAAK,cAAc,WAAW,IAAI,YAAY,aAAa,YAAY;AAAA,EACzE;AACF;AAKA,SAAS,qBAAqB,aAA8D;AAC1F,SAAO;AAAA,IACL,MAAM,cAAc,WAAW,IAC3B,YAAY,cAAc,YAAY,cACtC,SAAS,gBAAgB,cAAc,OAAO;AAAA,IAClD,KAAK,cAAc,WAAW,IAC1B,YAAY,eAAe,YAAY,eACvC,SAAS,gBAAgB,eAAe,OAAO;AAAA,EACrD;AACF;AAKA,SAAS,wBACP,uBACA,mBACA,QACA,MACA,QACgB;AAChB,MAAI,EAAE,KAAK,KAAK,IAAI;AAEpB,MAAI,kBAAkB,eAAe,SAAS,MAAM,GAAG;AACrD,UAAM,gBAAgB,kBAAkB,cAAc,SAAS,SAAS,cAAc,MAAM;AAE5F,QAAI,CAAC,eAAe;AAClB,aAAO,EAAE,KAAK,KAAK;AAAA,IACrB;AAEA,UAAM,QAAQ,cAAc,sBAAsB;AAClD,UAAM,SAAS,iBAAiB,aAAa;AAC7C,UAAM,eAAe;AAAA,MACnB,MAAM,OAAO,SAAS,OAAO,oBAAoB,KAAK,EAAE;AAAA,MACxD,KAAK,OAAO,SAAS,OAAO,mBAAmB,KAAK,EAAE;AAAA,IACxD;AAGA,WAAO,MAAM,OAAO,sBAAsB,OAAO,aAAa;AAC9D,UAAM,MAAM,MAAM,sBAAsB,MAAM,aAAa;AAAA,EAC7D,WAAW,SAAS,MAAM,GAAG;AAC3B,WAAO;AACP,UAAM;AAAA,EACR,OAAO;AACL,WAAO,OAAO,QAAQ;AACtB,UAAM,OAAO,OAAO;AAAA,EACtB;AAEA,UAAQ;AACR,SAAO;AAEP,MAAI,SAAS,UAAU;AACrB,QAAI,SAAS,SAAS,CAAC,UAAW,OAAmC,IAAI,GAAG;AAC1E,aAAO,sBAAsB;AAAA,IAC/B;AAEA,QAAI,SAAS,OAAO;AAClB,YAAM,sBAAsB;AAAA,IAC9B;AAAA,EACF;AAEA,SAAO;AAAA,IACL,MAAM,KAAK,IAAI,MAAM,kBAAkB,IAAI;AAAA,IAC3C,KAAK,KAAK,IAAI,KAAK,kBAAkB,GAAG;AAAA,EAC1C;AACF;AAQO,SAAS,SACd,QACA,EAAE,cAAc,QAAQ,OAAO,OAAO,SAAS,GAAG,GAAG,aAAa,IAAqB,CAAC,GAC/D;AACzB,QAAM,wBAAwB,yBAAyB,WAAW;AAClE,QAAM,oBAAoB,qBAAqB,WAAW;AAC1D,QAAM,uBAAuB;AAAA,IAC3B;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAEA,SAAO,IAAI,QAAQ,CAAC,YAAY;AAC9B,aAAS,eAAe;AAEtB,SAAG,MAAM;AACT,WAAK;AAAA,IAEP;AAEA,aAAS,OAAO;AACd,kBAAY,oBAAoB,SAAS,YAAY;AACrD,kBAAY,oBAAoB,aAAa,YAAY;AAGzD,cAAQ,yBAAyB,WAAW,CAAC;AAAA,IAC/C;AAGA,UAAM,KAAK;AAAA,MACT,CAAC,aAAa;AACZ,oBAAY,SAAS;AAAA,UACnB,MAAM,KAAK,sBAAsB,MAAM,qBAAqB,MAAM,QAAQ;AAAA,UAC1E,KAAK,KAAK,sBAAsB,KAAK,qBAAqB,KAAK,QAAQ;AAAA,UACvE,UAAU;AAAA,QACZ,CAAC;AAAA,MACH;AAAA,MACA;AAAA,QACE,QAAQ;AAAA,QACR,GAAG;AAAA,QACH,SAAS,UAAU;AACjB,cAAI,WAAW,aAAa,QAAQ,GAAG;AACrC,yBAAa,SAAS,QAAQ;AAAA,UAChC;AAEA,eAAK;AAAA,QACP;AAAA,MACF;AAAA,IACF;AAEA,gBAAY,iBAAiB,SAAS,cAAc,EAAE,SAAS,KAAK,CAAC;AACrE,gBAAY,iBAAiB,aAAa,cAAc,EAAE,SAAS,KAAK,CAAC;AACzE,OAAG,MAAM;AAAA,EACX,CAAC;AACH;AAEA,SAAS,OAAO;AAAA,EACd,GAAG;AAAA,EACH,GAAG;AAAA,EACH,MAAM;AACR;",
   "names": []
 }

package/utils/string/changeCase.d.ts

@@ -1,24 +1,30 @@
 /**
  * Convert a string to lowercase.
- */
+ * @link https://js-toolkit.studiometa.dev/utils/string/lowerCase.html
+*/
 export declare function lowerCase(string: string): string;
 /**
  * Convert a string to UPPERCASE.
- */
+ * @link https://js-toolkit.studiometa.dev/utils/string/upperCase.html
+*/
 export declare function upperCase(string: string): string;
 /**
  * Convert a string to camelCase.
- */
+ * @link https://js-toolkit.studiometa.dev/utils/string/camelCase.html
+*/
 export declare const camelCase: (string: string) => string;
 /**
  * Convert a string to PascalCase.
- */
+ * @link https://js-toolkit.studiometa.dev/utils/string/pascalCase.html
+*/
 export declare const pascalCase: (string: string) => string;
 /**
  * Convert a string to snake_case.
- */
+ * @link https://js-toolkit.studiometa.dev/utils/string/snakeCase.html
+*/
 export declare const snakeCase: (string: string) => string;
 /**
  * Convert a string to dash-case.
- */
+ * @link https://js-toolkit.studiometa.dev/utils/string/dashCase.html
+*/
 export declare const dashCase: (string: string) => string;

package/utils/string/changeCase.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../packages/js-toolkit/utils/string/changeCase.ts"],
-  "sourcesContent": ["import { memo } from '../memo.js';\n\nconst SPLIT_LOWER_UPPER_RE = /([\\p{Ll}\\d])(\\p{Lu})/gu;\nconst SPLIT_UPPER_UPPER_RE = /(\\p{Lu})([\\p{Lu}][\\p{Ll}])/gu;\nconst DEFAULT_STRIP_REGEXP = /[^\\p{L}\\d]+/giu;\nconst SPLIT_REPLACE_VALUE = '$1\\0$2';\n\n/**\n * Split function from the `change-case` package.\n * @see https://github.com/blakeembrey/change-case\n */\nfunction split(value: string) {\n  let result = value.trim();\n\n  result = result\n    .replace(SPLIT_LOWER_UPPER_RE, SPLIT_REPLACE_VALUE)\n    .replace(SPLIT_UPPER_UPPER_RE, SPLIT_REPLACE_VALUE);\n\n  result = result.replace(DEFAULT_STRIP_REGEXP, '\\0');\n\n  let start = 0;\n  let end = result.length;\n\n  // Trim the delimiter from around the output string.\n  while (result.charAt(start) === '\\0') start++;\n  if (start === end) return [];\n  while (result.charAt(end - 1) === '\\0') end--;\n\n  return result.slice(start, end).split(/\\0/g);\n}\n\n/**\n * Convert a string to lowercase and join each word with the given delimiter.\n */\nfunction delimitedCase(string: string, delimiter: string): string {\n  return split(string)\n    .map((word) => lowerCase(word))\n    .join(delimiter);\n}\n/**\n * Convert a string to lowercase.\n */\nexport function lowerCase(string: string): string {\n  return string.toLowerCase();\n}\n\n/**\n * Convert a string to UPPERCASE.\n */\nexport function upperCase(string: string): string {\n  return string.toUpperCase();\n}\n\n/**\n * Convert a string to camelCase.\n */\nexport const camelCase = memo(function camelCase(string: string): string {\n  const result = pascalCase(string);\n  return lowerCase(result[0]) + result.slice(1);\n});\n\n/**\n * Convert a string to PascalCase.\n */\nexport const pascalCase = memo(function pascalCase(string: string): string {\n  return split(string)\n    .map((word) => upperCase(word[0]) + lowerCase(word.slice(1)))\n    .join('');\n});\n\n/**\n * Convert a string to snake_case.\n */\nexport const snakeCase = memo(function snakeCase(string: string): string {\n  return delimitedCase(string, '_');\n});\n\n/**\n * Convert a string to dash-case.\n */\nexport const dashCase = memo(function dashCase(string: string): string {\n  return delimitedCase(string, '-');\n});\n"],
-  "mappings": "AAAA,SAAS,YAAY;AAErB,MAAM,uBAAuB;AAC7B,MAAM,uBAAuB;AAC7B,MAAM,uBAAuB;AAC7B,MAAM,sBAAsB;AAM5B,SAAS,MAAM,OAAe;AAC5B,MAAI,SAAS,MAAM,KAAK;AAExB,WAAS,OACN,QAAQ,sBAAsB,mBAAmB,EACjD,QAAQ,sBAAsB,mBAAmB;AAEpD,WAAS,OAAO,QAAQ,sBAAsB,IAAI;AAElD,MAAI,QAAQ;AACZ,MAAI,MAAM,OAAO;AAGjB,SAAO,OAAO,OAAO,KAAK,MAAM,KAAM;AACtC,MAAI,UAAU,IAAK,QAAO,CAAC;AAC3B,SAAO,OAAO,OAAO,MAAM,CAAC,MAAM,KAAM;AAExC,SAAO,OAAO,MAAM,OAAO,GAAG,EAAE,MAAM,KAAK;AAC7C;AAKA,SAAS,cAAc,QAAgB,WAA2B;AAChE,SAAO,MAAM,MAAM,EAChB,IAAI,CAAC,SAAS,UAAU,IAAI,CAAC,EAC7B,KAAK,SAAS;AACnB;AAIO,SAAS,UAAU,QAAwB;AAChD,SAAO,OAAO,YAAY;AAC5B;AAKO,SAAS,UAAU,QAAwB;AAChD,SAAO,OAAO,YAAY;AAC5B;AAKO,MAAM,YAAY,KAAK,SAASA,WAAU,QAAwB;AACvE,QAAM,SAAS,WAAW,MAAM;AAChC,SAAO,UAAU,OAAO,CAAC,CAAC,IAAI,OAAO,MAAM,CAAC;AAC9C,CAAC;AAKM,MAAM,aAAa,KAAK,SAASC,YAAW,QAAwB;AACzE,SAAO,MAAM,MAAM,EAChB,IAAI,CAAC,SAAS,UAAU,KAAK,CAAC,CAAC,IAAI,UAAU,KAAK,MAAM,CAAC,CAAC,CAAC,EAC3D,KAAK,EAAE;AACZ,CAAC;AAKM,MAAM,YAAY,KAAK,SAASC,WAAU,QAAwB;AACvE,SAAO,cAAc,QAAQ,GAAG;AAClC,CAAC;AAKM,MAAM,WAAW,KAAK,SAASC,UAAS,QAAwB;AACrE,SAAO,cAAc,QAAQ,GAAG;AAClC,CAAC;",
+  "sourcesContent": ["import { memo } from '../memo.js';\n\nconst SPLIT_LOWER_UPPER_RE = /([\\p{Ll}\\d])(\\p{Lu})/gu;\nconst SPLIT_UPPER_UPPER_RE = /(\\p{Lu})([\\p{Lu}][\\p{Ll}])/gu;\nconst DEFAULT_STRIP_REGEXP = /[^\\p{L}\\d]+/giu;\nconst SPLIT_REPLACE_VALUE = '$1\\0$2';\n\n/**\n * Split function from the `change-case` package.\n * @link https://github.com/blakeembrey/change-case\n */\nfunction split(value: string) {\n  let result = value.trim();\n\n  result = result\n    .replace(SPLIT_LOWER_UPPER_RE, SPLIT_REPLACE_VALUE)\n    .replace(SPLIT_UPPER_UPPER_RE, SPLIT_REPLACE_VALUE);\n\n  result = result.replace(DEFAULT_STRIP_REGEXP, '\\0');\n\n  let start = 0;\n  let end = result.length;\n\n  // Trim the delimiter from around the output string.\n  while (result.charAt(start) === '\\0') start++;\n  if (start === end) return [];\n  while (result.charAt(end - 1) === '\\0') end--;\n\n  return result.slice(start, end).split(/\\0/g);\n}\n\n/**\n * Convert a string to lowercase and join each word with the given delimiter.\n */\nfunction delimitedCase(string: string, delimiter: string): string {\n  return split(string)\n    .map((word) => lowerCase(word))\n    .join(delimiter);\n}\n/**\n * Convert a string to lowercase.\n * @link https://js-toolkit.studiometa.dev/utils/string/lowerCase.html\n*/\nexport function lowerCase(string: string): string {\n  return string.toLowerCase();\n}\n\n/**\n * Convert a string to UPPERCASE.\n * @link https://js-toolkit.studiometa.dev/utils/string/upperCase.html\n*/\nexport function upperCase(string: string): string {\n  return string.toUpperCase();\n}\n\n/**\n * Convert a string to camelCase.\n * @link https://js-toolkit.studiometa.dev/utils/string/camelCase.html\n*/\nexport const camelCase = memo(function camelCase(string: string): string {\n  const result = pascalCase(string);\n  return lowerCase(result[0]) + result.slice(1);\n});\n\n/**\n * Convert a string to PascalCase.\n * @link https://js-toolkit.studiometa.dev/utils/string/pascalCase.html\n*/\nexport const pascalCase = memo(function pascalCase(string: string): string {\n  return split(string)\n    .map((word) => upperCase(word[0]) + lowerCase(word.slice(1)))\n    .join('');\n});\n\n/**\n * Convert a string to snake_case.\n * @link https://js-toolkit.studiometa.dev/utils/string/snakeCase.html\n*/\nexport const snakeCase = memo(function snakeCase(string: string): string {\n  return delimitedCase(string, '_');\n});\n\n/**\n * Convert a string to dash-case.\n * @link https://js-toolkit.studiometa.dev/utils/string/dashCase.html\n*/\nexport const dashCase = memo(function dashCase(string: string): string {\n  return delimitedCase(string, '-');\n});\n"],
+  "mappings": "AAAA,SAAS,YAAY;AAErB,MAAM,uBAAuB;AAC7B,MAAM,uBAAuB;AAC7B,MAAM,uBAAuB;AAC7B,MAAM,sBAAsB;AAM5B,SAAS,MAAM,OAAe;AAC5B,MAAI,SAAS,MAAM,KAAK;AAExB,WAAS,OACN,QAAQ,sBAAsB,mBAAmB,EACjD,QAAQ,sBAAsB,mBAAmB;AAEpD,WAAS,OAAO,QAAQ,sBAAsB,IAAI;AAElD,MAAI,QAAQ;AACZ,MAAI,MAAM,OAAO;AAGjB,SAAO,OAAO,OAAO,KAAK,MAAM,KAAM;AACtC,MAAI,UAAU,IAAK,QAAO,CAAC;AAC3B,SAAO,OAAO,OAAO,MAAM,CAAC,MAAM,KAAM;AAExC,SAAO,OAAO,MAAM,OAAO,GAAG,EAAE,MAAM,KAAK;AAC7C;AAKA,SAAS,cAAc,QAAgB,WAA2B;AAChE,SAAO,MAAM,MAAM,EAChB,IAAI,CAAC,SAAS,UAAU,IAAI,CAAC,EAC7B,KAAK,SAAS;AACnB;AAKO,SAAS,UAAU,QAAwB;AAChD,SAAO,OAAO,YAAY;AAC5B;AAMO,SAAS,UAAU,QAAwB;AAChD,SAAO,OAAO,YAAY;AAC5B;AAMO,MAAM,YAAY,KAAK,SAASA,WAAU,QAAwB;AACvE,QAAM,SAAS,WAAW,MAAM;AAChC,SAAO,UAAU,OAAO,CAAC,CAAC,IAAI,OAAO,MAAM,CAAC;AAC9C,CAAC;AAMM,MAAM,aAAa,KAAK,SAASC,YAAW,QAAwB;AACzE,SAAO,MAAM,MAAM,EAChB,IAAI,CAAC,SAAS,UAAU,KAAK,CAAC,CAAC,IAAI,UAAU,KAAK,MAAM,CAAC,CAAC,CAAC,EAC3D,KAAK,EAAE;AACZ,CAAC;AAMM,MAAM,YAAY,KAAK,SAASC,WAAU,QAAwB;AACvE,SAAO,cAAc,QAAQ,GAAG;AAClC,CAAC;AAMM,MAAM,WAAW,KAAK,SAASC,UAAS,QAAwB;AACrE,SAAO,cAAc,QAAQ,GAAG;AAClC,CAAC;",
   "names": ["camelCase", "pascalCase", "snakeCase", "dashCase"]
 }

package/utils/string/endsWith.d.ts

@@ -3,6 +3,7 @@
  *
  * This is a more performant version of the `String.prototype.endsWith` method.
  *
- * @see https://jsbench.me/1hlkqqd0ff/2
+ * @link https://jsbench.me/1hlkqqd0ff/2
+ * @link https://js-toolkit.studiometa.dev/utils/string/endsWith.html
  */
 export declare function endsWith(string: string, search: string): boolean;

package/utils/string/endsWith.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../packages/js-toolkit/utils/string/endsWith.ts"],
-  "sourcesContent": ["/**\n * Test if a string starts with another string.\n *\n * This is a more performant version of the `String.prototype.endsWith` method.\n *\n * @see https://jsbench.me/1hlkqqd0ff/2\n */\nexport function endsWith(string: string, search: string): boolean {\n  if (search.length === 0) {\n    return true;\n  }\n\n  if (search.length === 1) {\n    // eslint-disable-next-line unicorn/prefer-at\n    return string[string.length - 1] === search;\n  }\n\n  // eslint-disable-next-line unicorn/prefer-string-slice\n  return string.substring(string.length - search.length) === search;\n}\n"],
-  "mappings": "AAOO,SAAS,SAAS,QAAgB,QAAyB;AAChE,MAAI,OAAO,WAAW,GAAG;AACvB,WAAO;AAAA,EACT;AAEA,MAAI,OAAO,WAAW,GAAG;AAEvB,WAAO,OAAO,OAAO,SAAS,CAAC,MAAM;AAAA,EACvC;AAGA,SAAO,OAAO,UAAU,OAAO,SAAS,OAAO,MAAM,MAAM;AAC7D;",
+  "sourcesContent": ["/**\n * Test if a string starts with another string.\n *\n * This is a more performant version of the `String.prototype.endsWith` method.\n *\n * @link https://jsbench.me/1hlkqqd0ff/2\n * @link https://js-toolkit.studiometa.dev/utils/string/endsWith.html\n */\nexport function endsWith(string: string, search: string): boolean {\n  if (search.length === 0) {\n    return true;\n  }\n\n  if (search.length === 1) {\n    // eslint-disable-next-line unicorn/prefer-at\n    return string[string.length - 1] === search;\n  }\n\n  // eslint-disable-next-line unicorn/prefer-string-slice\n  return string.substring(string.length - search.length) === search;\n}\n"],
+  "mappings": "AAQO,SAAS,SAAS,QAAgB,QAAyB;AAChE,MAAI,OAAO,WAAW,GAAG;AACvB,WAAO;AAAA,EACT;AAEA,MAAI,OAAO,WAAW,GAAG;AAEvB,WAAO,OAAO,OAAO,SAAS,CAAC,MAAM;AAAA,EACvC;AAGA,SAAO,OAAO,UAAU,OAAO,SAAS,OAAO,MAAM,MAAM;AAC7D;",
   "names": []
 }