@studiometa/js-toolkit 2.11.2 → 3.0.0-alpha.1

package/utils/nextFrame.d.ts

@@ -1,25 +1,7 @@
-/**
- * RequestAnimation frame polyfill.
- *
- * @see  https://github.com/vuejs/vue/blob/ec78fc8b6d03e59da669be1adf4b4b5abf670a34/dist/vue.runtime.esm.js#L7355
- */
-export declare function getRaf(): (handler: Function) => number;
-/**
- * Get a function to cancel the method returned by `getRaf()`.
- */
-export declare function getCancelRaf(): (id: number) => void;
+type Callback = (time?: DOMHighResTimeStamp) => any;
 /**
  * Wait for the next frame to execute a function.
- *
- * @template {() => any} T
- * @param    {T} [fn] The callback function to execute.
- * @returns  {Promise<T extends Function ? ReturnType<T> : undefined>} A Promise resolving when the next frame is reached.
- * @example
- * ```js
- * nextFrame(() => console.log('hello world'));
- *
- * await nextFrame();
- * console.log('hello world');
- * ```
  */
-export declare function nextFrame<T extends () => unknown>(fn?: T): Promise<T extends () => unknown ? ReturnType<T> : void>;
+export declare function nextFrame(): Promise<DOMHighResTimeStamp>;
+export declare function nextFrame<T extends Callback>(callback?: T): Promise<ReturnType<T>>;
+export {};

package/utils/nextFrame.js

@@ -1,19 +1,12 @@
 import { isFunction } from "./is.js";
 import { hasWindow } from "./has.js";
-function getRaf() {
-  return hasWindow() && window.requestAnimationFrame ? window.requestAnimationFrame.bind(window) : setTimeout;
-}
-function getCancelRaf() {
-  return hasWindow() && window.cancelAnimationFrame ? window.cancelAnimationFrame.bind(window) : clearTimeout;
-}
-function nextFrame(fn) {
+function nextFrame(callback) {
+  const fn = hasWindow() ? window?.requestAnimationFrame ?? setTimeout : setTimeout;
   return new Promise((resolve) => {
-    getRaf()(() => resolve(isFunction(fn) && fn()));
+    fn((time) => resolve(isFunction(callback) ? callback(time) : time));
   });
 }
 export {
-  getCancelRaf,
-  getRaf,
   nextFrame
 };
 //# sourceMappingURL=nextFrame.js.map

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/**\n * RequestAnimation frame polyfill.\n *\n * @see  https://github.com/vuejs/vue/blob/ec78fc8b6d03e59da669be1adf4b4b5abf670a34/dist/vue.runtime.esm.js#L7355\n */\n// eslint-disable-next-line @typescript-eslint/ban-types\nexport function getRaf(): (handler: Function) => number {\n  return hasWindow() && window.requestAnimationFrame\n    ? window.requestAnimationFrame.bind(window)\n    : setTimeout;\n}\n\n/**\n * Get a function to cancel the method returned by `getRaf()`.\n */\nexport function getCancelRaf(): (id: number) => void {\n  return hasWindow() && window.cancelAnimationFrame\n    ? window.cancelAnimationFrame.bind(window)\n    : clearTimeout;\n}\n\n/**\n * Wait for the next frame to execute a function.\n *\n * @template {() => any} T\n * @param    {T} [fn] The callback function to execute.\n * @returns  {Promise<T extends Function ? ReturnType<T> : undefined>} A Promise resolving when the next frame is reached.\n * @example\n * ```js\n * nextFrame(() => console.log('hello world'));\n *\n * await nextFrame();\n * console.log('hello world');\n * ```\n */\nexport function nextFrame<T extends () => unknown>(\n  fn?: T,\n): Promise<T extends () => unknown ? ReturnType<T> : void> {\n  return new Promise((resolve) => {\n    // @ts-ignore\n    getRaf()(() => resolve(isFunction(fn) && fn()));\n  });\n}\n"],
-  "mappings": "AAAA,SAAS,kBAAkB;AAC3B,SAAS,iBAAiB;AAQnB,SAAS,SAAwC;AACtD,SAAO,UAAU,KAAK,OAAO,wBACzB,OAAO,sBAAsB,KAAK,MAAM,IACxC;AACN;AAKO,SAAS,eAAqC;AACnD,SAAO,UAAU,KAAK,OAAO,uBACzB,OAAO,qBAAqB,KAAK,MAAM,IACvC;AACN;AAgBO,SAAS,UACd,IACyD;AACzD,SAAO,IAAI,QAAQ,CAAC,YAAY;AAE9B,WAAO,EAAE,MAAM,QAAQ,WAAW,EAAE,KAAK,GAAG,CAAC,CAAC;AAAA,EAChD,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 */\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,IAAI,QAAQ,yBAAyB,aAAa;AACvE,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,4 +1,7 @@
+type Callback = (...args: any[]) => any;
 /**
  * Wait for the next microtask.
  */
-export default function nextMicrotask<T extends () => unknown>(fn?: T): Promise<T extends () => unknown ? ReturnType<T> : void>;
+export declare function nextMicrotask(): Promise<void>;
+export declare function nextMicrotask<T extends Callback>(callback?: T): Promise<ReturnType<T>>;
+export {};

package/utils/nextMicrotask.js

@@ -1,8 +1,8 @@
 import { isFunction } from "./is.js";
-async function nextMicrotask(fn) {
-  return Promise.resolve().then(() => isFunction(fn) && fn());
+async function nextMicrotask(callback) {
+  return Promise.resolve().then(() => isFunction(callback) && callback());
 }
 export {
-  nextMicrotask as default
+  nextMicrotask
 };
 //# sourceMappingURL=nextMicrotask.js.map

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/**\n * Wait for the next microtask.\n */\nexport default async function nextMicrotask<T extends () => unknown>(\n  fn?: T,\n): Promise<T extends () => unknown ? ReturnType<T> : void> {\n  // @ts-ignore\n  return Promise.resolve().then(() => isFunction(fn) && fn());\n}\n"],
-  "mappings": "AAAA,SAAS,kBAAkB;AAK3B,eAAO,cACL,IACyD;AAEzD,SAAO,QAAQ,QAAQ,EAAE,KAAK,MAAM,WAAW,EAAE,KAAK,GAAG,CAAC;AAC5D;",
+  "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;",
   "names": []
 }

package/utils/nextTick.d.ts

@@ -1,4 +1,7 @@
+type Callback = (...args: any[]) => any;
 /**
  * Wait for the next tick.
  */
-export default function nextTick<T extends () => any>(fn?: T): Promise<T extends void ? void : ReturnType<T>>;
+export declare function nextTick(): Promise<void>;
+export declare function nextTick<T extends Callback>(callback?: T): Promise<ReturnType<T>>;
+export {};

package/utils/nextTick.js

@@ -1,9 +1,9 @@
 import { isFunction } from "./is.js";
 import { wait } from "./wait.js";
-async function nextTick(fn) {
-  return wait().then(isFunction(fn) && fn);
+async function nextTick(callback) {
+  return wait().then(isFunction(callback) && callback);
 }
 export {
-  nextTick as default
+  nextTick
 };
 //# sourceMappingURL=nextTick.js.map

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/**\n * Wait for the next tick.\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport default async function nextTick<T extends () => any>(\n  fn?: T,\n): Promise<T extends void ? void : ReturnType<T>> {\n  return wait().then(isFunction(fn) && (fn as ReturnType<T>));\n}\n"],
-  "mappings": "AAAA,SAAS,kBAAkB;AAC3B,SAAS,YAAY;AAMrB,eAAO,SACL,IACgD;AAChD,SAAO,KAAK,EAAE,KAAK,WAAW,EAAE,KAAM,EAAoB;AAC5D;",
+  "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;",
   "names": []
 }

package/utils/random.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Get a random integer between bounds
+ *
+ * @param {number} a Lower bound
+ * @param {number} b Upper bound
+ * @returns {number}
+ */
+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}
+ */
+export declare function randomItem<T>(items: T[] | string): T | string | undefined;

package/utils/random.js

@@ -0,0 +1,15 @@
+import { isArray, isString } from "./is";
+function randomInt(a, b = 0) {
+  return Math.floor(Math.random() * (a - b + 1)) + b;
+}
+function randomItem(items) {
+  if (!isArray(items) && !isString(items)) {
+    throw new Error("randomItem() expects an array or a string as argument.");
+  }
+  return items.length > 0 ? items[randomInt(items.length - 1)] : void 0;
+}
+export {
+  randomInt,
+  randomItem
+};
+//# sourceMappingURL=random.js.map

package/utils/random.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../packages/js-toolkit/utils/random.ts"],
+  "sourcesContent": ["import { isArray, isString } from './is';\n\n/**\n * Get a random integer between bounds\n *\n * @param {number} a Lower bound\n * @param {number} b Upper bound\n * @returns {number}\n */\nexport function randomInt(a: number, b = 0): number {\n  return Math.floor(Math.random() * (a - b + 1)) + 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 */\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,UAAU,GAAW,IAAI,GAAW;AAClD,SAAO,KAAK,MAAM,KAAK,OAAO,KAAK,IAAI,IAAI,EAAE,IAAI;AACnD;AAQO,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.js

@@ -10,9 +10,9 @@ function getScheduler(steps) {
     }
   }
   function flush() {
-    steps.forEach((step) => {
+    for (const step of steps) {
       run(stepsFns[step]);
-    });
+    }
     isScheduled = false;
     if (steps.reduce((length, step) => length + stepsFns[step].length, 0) > 0) {
       scheduleFlush();
@@ -25,13 +25,13 @@ function getScheduler(steps) {
     isScheduled = true;
     resolvedPromise.then(flush);
   }
-  steps.forEach((step) => {
+  for (const step of steps) {
     stepsFns[step] = [];
     api[step] = function add(fn) {
       stepsFns[step].push(fn);
       scheduleFlush();
     };
-  });
+  }
   return api;
 }
 const instances = /* @__PURE__ */ new Map();

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    steps.forEach((step) => {\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  steps.forEach((step) => {\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,UAAM,QAAQ,CAAC,SAAS;AACtB,UAAI,SAAS,KAAK;AAAA,IACpB,CAAC;AACD,kBAAc;AAEd,QAAI,MAAM,OAAO,CAAC,QAAQ,SAAS,SAAS,SAAS,MAAM,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,QAAM,QAAQ,CAAC,SAAS;AACtB,aAAS,QAAQ,CAAC;AAClB,QAAI,QAAQ,SAAS,IAAI,IAAI;AAC3B,eAAS,MAAM,KAAK,EAAE;AACtB,oBAAc;AAAA,IAChB;AAAA,EACF,CAAC;AAED,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 */\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;",
   "names": []
 }

package/utils/scrollTo.d.ts

@@ -1,9 +1,33 @@
+import type { TweenOptions } from './tween.js';
+export interface ScrollPosition {
+    left: number;
+    top: number;
+}
+export type ScrollTarget = string | HTMLElement | number | Partial<ScrollPosition>;
+export interface ScrollToOptions extends TweenOptions {
+    /**
+     * Root element that will be scrolled.
+     */
+    rootElement?: HTMLElement | typeof window;
+    /**
+     * Scroll direction.
+     */
+    axis?: (typeof scrollTo.axis)[keyof typeof scrollTo.axis];
+    /**
+     * Distance from the target.
+     */
+    offset?: number;
+}
 /**
- * Handler for the click event on anchor links
+ * Scroll to an element.
  *
- * @returns {Promise<number>} A promising resolving with the target scroll position.
+ * @returns {Promise<ScrollPosition>} A promising resolving with the scroll position.
  */
-export default function scrollTo(selectorElement: HTMLElement | string, { offset, dampFactor }?: {
-    offset?: number;
-    dampFactor?: number;
-}): Promise<number>;
+export declare function scrollTo(target: string | HTMLElement | number | Partial<ScrollPosition>, { rootElement, axis, offset, ...tweenOptions }?: ScrollToOptions): Promise<ScrollPosition>;
+export declare namespace scrollTo {
+    var axis: {
+        x: symbol;
+        y: symbol;
+        both: symbol;
+    };
+}

package/utils/scrollTo.js

@@ -1,56 +1,110 @@
-import damp from "./math/damp.js";
-function scrollTo(selectorElement, { offset = 0, dampFactor = 0.2 } = {}) {
-  let targetElement = null;
-  if (selectorElement instanceof HTMLElement) {
-    targetElement = selectorElement;
+import { tween } from "./tween.js";
+import { isString, isNumber, isFunction, isDefined } from "./is.js";
+import { lerp } from "./math/index.js";
+const xAxis = Symbol(0);
+const yAxis = Symbol(1);
+const bothAxis = Symbol(2);
+function isHtmlElement(rootElement) {
+  return rootElement instanceof HTMLElement;
+}
+function getCurrentScrollPosition(rootElement) {
+  return {
+    left: isHtmlElement(rootElement) ? rootElement.scrollTop : rootElement.scrollX,
+    top: isHtmlElement(rootElement) ? rootElement.scrollLeft : rootElement.scrollY
+  };
+}
+function getMaxScrollPosition(rootElement) {
+  return {
+    left: isHtmlElement(rootElement) ? rootElement.scrollWidth - rootElement.offsetWidth : document.documentElement.scrollWidth - window.innerWidth,
+    top: isHtmlElement(rootElement) ? rootElement.scrollHeight - rootElement.offsetHeight : document.documentElement.scrollHeight - window.innerHeight
+  };
+}
+function getTargetScrollPosition(initialScrollPosition, maxScrollPosition, target, axis, offset) {
+  let { top, left } = initialScrollPosition;
+  if (target instanceof HTMLElement || isString(target)) {
+    const targetElement = target instanceof HTMLElement ? target : document.querySelector(target);
+    if (!targetElement) {
+      return { top, left };
+    }
+    const sizes = targetElement.getBoundingClientRect();
+    const styles = getComputedStyle(targetElement);
+    const scrollMargin = {
+      left: Number.parseInt(styles.scrollMarginLeft || "0", 10),
+      top: Number.parseInt(styles.scrollMarginTop || "0", 10)
+    };
+    left = sizes.left + initialScrollPosition.left - scrollMargin.left;
+    top = sizes.top + initialScrollPosition.top - scrollMargin.top;
+  } else if (isNumber(target)) {
+    left = target;
+    top = target;
   } else {
-    targetElement = document.querySelector(selectorElement);
-  }
-  if (!targetElement) {
-    return Promise.resolve(window.pageYOffset);
+    left = target.left ?? left;
+    top = target.top ?? top;
   }
-  const sizes = targetElement.getBoundingClientRect();
-  const scrollMargin = getComputedStyle(targetElement).scrollMarginTop || "0";
-  const max = document.documentElement.scrollHeight - window.innerHeight;
-  let scrollTarget = sizes.top + window.pageYOffset - Number.parseInt(scrollMargin, 10) - offset;
-  if (scrollTarget > max) {
-    scrollTarget = max;
+  left -= offset;
+  top -= offset;
+  if (axis !== bothAxis) {
+    if (axis !== xAxis && !isDefined(target.left)) {
+      left = initialScrollPosition.left;
+    }
+    if (axis !== yAxis) {
+      top = initialScrollPosition.top;
+    }
   }
+  return {
+    left: Math.min(left, maxScrollPosition.left),
+    top: Math.min(top, maxScrollPosition.top)
+  };
+}
+function scrollTo(target, { rootElement = window, axis = yAxis, offset = 0, ...tweenOptions } = {}) {
+  const initialScrollPosition = getCurrentScrollPosition(rootElement);
+  const maxScrollPosition = getMaxScrollPosition(rootElement);
+  const targetScrollPosition = getTargetScrollPosition(
+    initialScrollPosition,
+    maxScrollPosition,
+    target,
+    axis,
+    offset
+  );
   return new Promise((resolve) => {
-    let isScrolling = false;
-    let scroll = window.pageYOffset;
-    let dampScroll = window.pageYOffset;
     function eventHandler() {
-      isScrolling = false;
+      tw.pause();
+      stop();
     }
-    function end() {
-      window.removeEventListener("wheel", eventHandler);
-      window.removeEventListener("touchmove", eventHandler);
-      resolve(window.pageYOffset);
+    function stop() {
+      rootElement.removeEventListener("wheel", eventHandler);
+      rootElement.removeEventListener("touchmove", eventHandler);
+      resolve(getCurrentScrollPosition(rootElement));
     }
-    function loop() {
-      if (!isScrolling) {
-        return end();
-      }
-      dampScroll = damp(scroll, dampScroll, dampFactor);
-      window.scrollTo({ top: dampScroll });
-      if (dampScroll === scroll) {
-        isScrolling = false;
+    const tw = tween(
+      (progress) => {
+        rootElement.scrollTo({
+          left: lerp(initialScrollPosition.left, targetScrollPosition.left, progress),
+          top: lerp(initialScrollPosition.top, targetScrollPosition.top, progress)
+        });
+      },
+      {
+        smooth: 0.2,
+        ...tweenOptions,
+        onFinish(progress) {
+          if (isFunction(tweenOptions.onFinish)) {
+            tweenOptions.onFinish(progress);
+          }
+          stop();
+        }
       }
-      return requestAnimationFrame(loop);
-    }
-    function start(target) {
-      isScrolling = true;
-      dampScroll = window.pageYOffset;
-      scroll = target;
-      window.addEventListener("wheel", eventHandler, { passive: true });
-      window.addEventListener("touchmove", eventHandler, { passive: true });
-      loop();
-    }
-    start(scrollTarget);
+    );
+    rootElement.addEventListener("wheel", eventHandler, { passive: true });
+    rootElement.addEventListener("touchmove", eventHandler, { passive: true });
+    tw.start();
   });
 }
+scrollTo.axis = {
+  x: xAxis,
+  y: yAxis,
+  both: bothAxis
+};
 export {
-  scrollTo as default
+  scrollTo
 };
 //# sourceMappingURL=scrollTo.js.map

package/utils/scrollTo.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../packages/js-toolkit/utils/scrollTo.ts"],
-  "sourcesContent": ["import damp from './math/damp.js';\n\n/**\n * Handler for the click event on anchor links\n *\n * @returns {Promise<number>} A promising resolving with the target scroll position.\n */\nexport default function scrollTo(\n  selectorElement: HTMLElement | string,\n  { offset = 0, dampFactor = 0.2 } = {},\n): Promise<number> {\n  let targetElement = null;\n\n  if (selectorElement instanceof HTMLElement) {\n    targetElement = selectorElement;\n  } else {\n    targetElement = document.querySelector(selectorElement);\n  }\n\n  if (!targetElement) {\n    return Promise.resolve(window.pageYOffset);\n  }\n\n  const sizes = targetElement.getBoundingClientRect();\n  const scrollMargin = getComputedStyle(targetElement).scrollMarginTop || '0';\n  const max = document.documentElement.scrollHeight - window.innerHeight;\n  let scrollTarget = sizes.top + window.pageYOffset - Number.parseInt(scrollMargin, 10) - offset;\n\n  // Make sure to not scroll more than the max scroll allowed\n  if (scrollTarget > max) {\n    scrollTarget = max;\n  }\n\n  return new Promise((resolve) => {\n    let isScrolling = false;\n    let scroll = window.pageYOffset;\n    let dampScroll = window.pageYOffset;\n\n    /**\n     * Handler for the wheel event\n     * Is used to cancel the programmatic scroll animation\n     */\n    function eventHandler() {\n      isScrolling = false;\n    }\n\n    /**\n     * Scroll animation end's hook\n     */\n    function end() {\n      window.removeEventListener('wheel', eventHandler);\n      window.removeEventListener('touchmove', eventHandler);\n      resolve(window.pageYOffset);\n    }\n\n    /**\n     * Scroll animation's loop\n     *\n     * @returns {void|number}\n     */\n    function loop() {\n      if (!isScrolling) {\n        return end();\n      }\n\n      dampScroll = damp(scroll, dampScroll, dampFactor);\n      window.scrollTo({ top: dampScroll });\n\n      if (dampScroll === scroll) {\n        isScrolling = false;\n      }\n\n      return requestAnimationFrame(loop);\n    }\n\n    /**\n     * Start the scroll animation\n     *\n     * @param {number} target The target scroll\n     */\n    function start(target) {\n      // Update vars\n      isScrolling = true;\n      dampScroll = window.pageYOffset;\n      scroll = target;\n\n      // Bind wheel event to stop the animation if\n      // the user wants to scroll manually\n      window.addEventListener('wheel', eventHandler, { passive: true });\n      window.addEventListener('touchmove', eventHandler, { passive: true });\n\n      // Init the loop\n      loop();\n    }\n\n    // Start the scroll\n    start(scrollTarget);\n  });\n}\n"],
-  "mappings": "AAAA,OAAO,UAAU;AAOF,SAAR,SACL,iBACA,EAAE,SAAS,GAAG,aAAa,IAAI,IAAI,CAAC,GACnB;AACjB,MAAI,gBAAgB;AAEpB,MAAI,2BAA2B,aAAa;AAC1C,oBAAgB;AAAA,EAClB,OAAO;AACL,oBAAgB,SAAS,cAAc,eAAe;AAAA,EACxD;AAEA,MAAI,CAAC,eAAe;AAClB,WAAO,QAAQ,QAAQ,OAAO,WAAW;AAAA,EAC3C;AAEA,QAAM,QAAQ,cAAc,sBAAsB;AAClD,QAAM,eAAe,iBAAiB,aAAa,EAAE,mBAAmB;AACxE,QAAM,MAAM,SAAS,gBAAgB,eAAe,OAAO;AAC3D,MAAI,eAAe,MAAM,MAAM,OAAO,cAAc,OAAO,SAAS,cAAc,EAAE,IAAI;AAGxF,MAAI,eAAe,KAAK;AACtB,mBAAe;AAAA,EACjB;AAEA,SAAO,IAAI,QAAQ,CAAC,YAAY;AAC9B,QAAI,cAAc;AAClB,QAAI,SAAS,OAAO;AACpB,QAAI,aAAa,OAAO;AAMxB,aAAS,eAAe;AACtB,oBAAc;AAAA,IAChB;AAKA,aAAS,MAAM;AACb,aAAO,oBAAoB,SAAS,YAAY;AAChD,aAAO,oBAAoB,aAAa,YAAY;AACpD,cAAQ,OAAO,WAAW;AAAA,IAC5B;AAOA,aAAS,OAAO;AACd,UAAI,CAAC,aAAa;AAChB,eAAO,IAAI;AAAA,MACb;AAEA,mBAAa,KAAK,QAAQ,YAAY,UAAU;AAChD,aAAO,SAAS,EAAE,KAAK,WAAW,CAAC;AAEnC,UAAI,eAAe,QAAQ;AACzB,sBAAc;AAAA,MAChB;AAEA,aAAO,sBAAsB,IAAI;AAAA,IACnC;AAOA,aAAS,MAAM,QAAQ;AAErB,oBAAc;AACd,mBAAa,OAAO;AACpB,eAAS;AAIT,aAAO,iBAAiB,SAAS,cAAc,EAAE,SAAS,KAAK,CAAC;AAChE,aAAO,iBAAiB,aAAa,cAAc,EAAE,SAAS,KAAK,CAAC;AAGpE,WAAK;AAAA,IACP;AAGA,UAAM,YAAY;AAAA,EACpB,CAAC;AACH;",
+  "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        });\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,QACzE,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/endsWith.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Test if a string starts with another string.
+ *
+ * This is a more performant version of the `String.prototype.endsWith` method.
+ *
+ * @see https://jsbench.me/1hlkqqd0ff/2
+ */
+export declare function endsWith(string: string, search: string): boolean;

package/utils/string/endsWith.js

@@ -0,0 +1,13 @@
+function endsWith(string, search) {
+  if (search.length === 0) {
+    return true;
+  }
+  if (search.length === 1) {
+    return string[string.length - 1] === search;
+  }
+  return string.substring(string.length - search.length) === search;
+}
+export {
+  endsWith
+};
+//# sourceMappingURL=endsWith.js.map

package/utils/string/endsWith.js.map

@@ -0,0 +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;",
+  "names": []
+}

package/utils/string/index.d.ts

@@ -8,3 +8,5 @@ export { default as withoutTrailingCharactersRecursive } from './withoutTrailing
 export { default as withoutTrailingSlash } from './withoutTrailingSlash.js';
 export { default as withTrailingCharacters } from './withTrailingCharacters.js';
 export { default as withTrailingSlash } from './withTrailingSlash.js';
+export * from './startsWith.js';
+export * from './endsWith.js';

package/utils/string/index.js

@@ -8,6 +8,8 @@ import { default as default8 } from "./withoutTrailingCharactersRecursive.js";
 import { default as default9 } from "./withoutTrailingSlash.js";
 import { default as default10 } from "./withTrailingCharacters.js";
 import { default as default11 } from "./withTrailingSlash.js";
+export * from "./startsWith.js";
+export * from "./endsWith.js";
 export {
   default2 as withLeadingCharacters,
   default3 as withLeadingSlash,

package/utils/string/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../packages/js-toolkit/utils/string/index.ts"],
-  "sourcesContent": ["export { default as withLeadingCharacters } from './withLeadingCharacters.js';\nexport { default as withLeadingSlash } from './withLeadingSlash.js';\nexport { default as withoutLeadingCharacters } from './withoutLeadingCharacters.js';\nexport { default as withoutLeadingCharactersRecursive } from './withoutLeadingCharactersRecursive.js';\nexport { default as withoutLeadingSlash } from './withoutLeadingSlash.js';\nexport { default as withoutTrailingCharacters } from './withoutTrailingCharacters.js';\nexport { default as withoutTrailingCharactersRecursive } from './withoutTrailingCharactersRecursive.js';\nexport { default as withoutTrailingSlash } from './withoutTrailingSlash.js';\nexport { default as withTrailingCharacters } from './withTrailingCharacters.js';\nexport { default as withTrailingSlash } from './withTrailingSlash.js';\n"],
-  "mappings": "AAAA,SAAoB,WAAXA,gBAAwC;AACjD,SAAoB,WAAXA,gBAAmC;AAC5C,SAAoB,WAAXA,gBAA2C;AACpD,SAAoB,WAAXA,gBAAoD;AAC7D,SAAoB,WAAXA,gBAAsC;AAC/C,SAAoB,WAAXA,gBAA4C;AACrD,SAAoB,WAAXA,gBAAqD;AAC9D,SAAoB,WAAXA,gBAAuC;AAChD,SAAoB,WAAXA,iBAAyC;AAClD,SAAoB,WAAXA,iBAAoC;",
+  "sourcesContent": ["export { default as withLeadingCharacters } from './withLeadingCharacters.js';\nexport { default as withLeadingSlash } from './withLeadingSlash.js';\nexport { default as withoutLeadingCharacters } from './withoutLeadingCharacters.js';\nexport { default as withoutLeadingCharactersRecursive } from './withoutLeadingCharactersRecursive.js';\nexport { default as withoutLeadingSlash } from './withoutLeadingSlash.js';\nexport { default as withoutTrailingCharacters } from './withoutTrailingCharacters.js';\nexport { default as withoutTrailingCharactersRecursive } from './withoutTrailingCharactersRecursive.js';\nexport { default as withoutTrailingSlash } from './withoutTrailingSlash.js';\nexport { default as withTrailingCharacters } from './withTrailingCharacters.js';\nexport { default as withTrailingSlash } from './withTrailingSlash.js';\nexport * from './startsWith.js';\nexport * from './endsWith.js';\n"],
+  "mappings": "AAAA,SAAoB,WAAXA,gBAAwC;AACjD,SAAoB,WAAXA,gBAAmC;AAC5C,SAAoB,WAAXA,gBAA2C;AACpD,SAAoB,WAAXA,gBAAoD;AAC7D,SAAoB,WAAXA,gBAAsC;AAC/C,SAAoB,WAAXA,gBAA4C;AACrD,SAAoB,WAAXA,gBAAqD;AAC9D,SAAoB,WAAXA,gBAAuC;AAChD,SAAoB,WAAXA,iBAAyC;AAClD,SAAoB,WAAXA,iBAAoC;AAC7C,cAAc;AACd,cAAc;",
   "names": ["default"]
 }

package/utils/string/startsWith.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Test if a string starts with another string.
+ *
+ * This is a more performant version of the `String.prototype.startsWith` method.
+ *
+ * @see https://jsbench.me/1hlkqqd0ff/1
+ */
+export declare function startsWith(string: string, search: string): boolean;

package/utils/string/startsWith.js

@@ -0,0 +1,13 @@
+function startsWith(string, search) {
+  if (search.length === 0) {
+    return true;
+  }
+  if (search.length === 1) {
+    return string[0] === search;
+  }
+  return string.substring(0, search.length) === search;
+}
+export {
+  startsWith
+};
+//# sourceMappingURL=startsWith.js.map

package/utils/string/startsWith.js.map

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

package/utils/string/withLeadingCharacters.js.map

@@ -2,6 +2,6 @@
   "version": 3,
   "sources": ["../../../packages/js-toolkit/utils/string/withLeadingCharacters.ts"],
   "sourcesContent": ["import withoutLeadingCharacters from './withoutLeadingCharacters.js';\n\n/**\n * Add the given characters to the start of the given string.\n *\n * @param   {string} string     The string to modify.\n * @param   {string} characters The characters to add to the start.\n * @returns {string}\n */\nexport default function withLeadingCharacters(string: string, characters: string): string {\n  return `${characters}${withoutLeadingCharacters(string, characters)}`;\n}\n"],
-  "mappings": "AAAA,OAAO,8BAA8B;AAStB,SAAR,sBAAuC,QAAgB,YAA4B;AACxF,SAAO,GAAG,aAAa,yBAAyB,QAAQ,UAAU;AACpE;",
+  "mappings": "AAAA,OAAO,8BAA8B;AAStB,SAAR,sBAAuC,QAAgB,YAA4B;AACxF,SAAO,GAAG,UAAU,GAAG,yBAAyB,QAAQ,UAAU,CAAC;AACrE;",
   "names": []
 }

package/utils/string/withTrailingCharacters.js.map

@@ -2,6 +2,6 @@
   "version": 3,
   "sources": ["../../../packages/js-toolkit/utils/string/withTrailingCharacters.ts"],
   "sourcesContent": ["import withoutTrailingCharacters from './withoutTrailingCharacters.js';\n\n/**\n * Add the given characters to the end of the given string.\n *\n * @param   {string} string     The string to modify.\n * @param   {string} characters The characters to add to the end.\n * @returns {string}\n */\nexport default function withTrailingCharacters(string: string, characters: string): string {\n  return `${withoutTrailingCharacters(string, characters)}${characters}`;\n}\n"],
-  "mappings": "AAAA,OAAO,+BAA+B;AASvB,SAAR,uBAAwC,QAAgB,YAA4B;AACzF,SAAO,GAAG,0BAA0B,QAAQ,UAAU,IAAI;AAC5D;",
+  "mappings": "AAAA,OAAO,+BAA+B;AASvB,SAAR,uBAAwC,QAAgB,YAA4B;AACzF,SAAO,GAAG,0BAA0B,QAAQ,UAAU,CAAC,GAAG,UAAU;AACtE;",
   "names": []
 }

package/utils/string/withoutLeadingCharacters.js.map

@@ -2,6 +2,6 @@
   "version": 3,
   "sources": ["../../../packages/js-toolkit/utils/string/withoutLeadingCharacters.ts"],
   "sourcesContent": ["/**\n * Remove the given characters from the start of the given string.\n *\n * @param   {string} string     The string to modify.\n * @param   {string} characters The characters to remove from the start.\n * @returns {string}\n */\nexport default function withoutLeadingCharacters(string: string, characters: string): string {\n  return string.replace(new RegExp(`^${characters}`), '');\n}\n"],
-  "mappings": "AAOe,SAAR,yBAA0C,QAAgB,YAA4B;AAC3F,SAAO,OAAO,QAAQ,IAAI,OAAO,IAAI,YAAY,GAAG,EAAE;AACxD;",
+  "mappings": "AAOe,SAAR,yBAA0C,QAAgB,YAA4B;AAC3F,SAAO,OAAO,QAAQ,IAAI,OAAO,IAAI,UAAU,EAAE,GAAG,EAAE;AACxD;",
   "names": []
 }