@studiometa/js-toolkit 2.0.0-beta.9 → 2.0.0

package/utils/nextFrame.cjs

@@ -0,0 +1,38 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// packages/js-toolkit/utils/nextFrame.js
+var nextFrame_exports = {};
+__export(nextFrame_exports, {
+  default: () => nextFrame,
+  getCancelRaf: () => getCancelRaf,
+  getRaf: () => getRaf
+});
+module.exports = __toCommonJS(nextFrame_exports);
+function getRaf() {
+  return typeof window !== "undefined" && window.requestAnimationFrame ? window.requestAnimationFrame.bind(window) : setTimeout;
+}
+function getCancelRaf() {
+  return typeof window !== "undefined" && window.cancelAnimationFrame ? window.cancelAnimationFrame.bind(window) : clearTimeout;
+}
+function nextFrame(fn) {
+  return new Promise((resolve) => {
+    getRaf()(() => resolve(typeof fn === "function" && fn()));
+  });
+}
+if (module.exports.default) module.exports = module.exports.default;

package/utils/nextFrame.d.ts

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

package/utils/nextFrame.js

@@ -1,13 +1,16 @@
-export function getRaf() {
-  return typeof window !== 'undefined' && window.requestAnimationFrame ? window.requestAnimationFrame.bind(window) : setTimeout;
+function getRaf() {
+  return typeof window !== "undefined" && window.requestAnimationFrame ? window.requestAnimationFrame.bind(window) : setTimeout;
 }
-export function getCancelRaf() {
-  return typeof window !== 'undefined' && window.cancelAnimationFrame ? window.cancelAnimationFrame.bind(window) : clearTimeout;
+function getCancelRaf() {
+  return typeof window !== "undefined" && window.cancelAnimationFrame ? window.cancelAnimationFrame.bind(window) : clearTimeout;
 }
-export default function nextFrame() {
-  var fn = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : () => {};
-  var raf = getRaf();
-  return new Promise(resolve => {
-    raf(() => raf(() => resolve(fn())));
+function nextFrame(fn) {
+  return new Promise((resolve) => {
+    getRaf()(() => resolve(typeof fn === "function" && fn()));
   });
-}
+}
+export {
+  nextFrame as default,
+  getCancelRaf,
+  getRaf
+};

package/utils/nextMicrotask.cjs

@@ -0,0 +1,28 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// packages/js-toolkit/utils/nextMicrotask.js
+var nextMicrotask_exports = {};
+__export(nextMicrotask_exports, {
+  default: () => nextMicrotask
+});
+module.exports = __toCommonJS(nextMicrotask_exports);
+async function nextMicrotask(fn) {
+  return Promise.resolve().then(() => typeof fn === "function" && fn());
+}
+if (module.exports.default) module.exports = module.exports.default;

package/utils/nextMicrotask.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Wait for the next microtask.
+ *
+ * @template {() => any} T
+ * @param    {T} [fn]
+ * @returns  {Promise<T extends Function ? ReturnType<T> : undefined>}
+ */
+export default function nextMicrotask<T extends () => any>(fn?: T): Promise<T extends Function ? ReturnType<T> : undefined>;

package/utils/nextMicrotask.js

@@ -0,0 +1,6 @@
+async function nextMicrotask(fn) {
+  return Promise.resolve().then(() => typeof fn === "function" && fn());
+}
+export {
+  nextMicrotask as default
+};

package/utils/nextTick.cjs

@@ -0,0 +1,30 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// packages/js-toolkit/utils/nextTick.js
+var nextTick_exports = {};
+__export(nextTick_exports, {
+  default: () => nextTick
+});
+module.exports = __toCommonJS(nextTick_exports);
+async function nextTick(fn) {
+  return new Promise((resolve) => setTimeout(() => {
+    resolve(typeof fn === "function" && fn());
+  }, 0));
+}
+if (module.exports.default) module.exports = module.exports.default;

package/utils/nextTick.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Wait for the next tick.
+ *
+ * @template {() => any} T
+ * @param    {T} [fn]
+ * @returns  {Promise<T extends Function ? ReturnType<T> : undefined>}
+ */
+export default function nextTick<T extends () => any>(fn?: T): Promise<T extends Function ? ReturnType<T> : undefined>;

package/utils/nextTick.js

@@ -0,0 +1,8 @@
+async function nextTick(fn) {
+  return new Promise((resolve) => setTimeout(() => {
+    resolve(typeof fn === "function" && fn());
+  }, 0));
+}
+export {
+  nextTick as default
+};

package/utils/object/autoBind.cjs

@@ -0,0 +1,49 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target, mod));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// packages/js-toolkit/utils/object/autoBind.js
+var autoBind_exports = {};
+__export(autoBind_exports, {
+  default: () => autoBind
+});
+module.exports = __toCommonJS(autoBind_exports);
+var import_getAllProperties = __toESM(require("./getAllProperties.cjs"), 1);
+function autoBind(instance, options) {
+  const { exclude, include } = options || {};
+  const filter = (key) => {
+    const match = (pattern) => typeof pattern === "string" ? key === pattern : pattern.test(key);
+    if (include) {
+      return include.some(match);
+    }
+    if (exclude) {
+      return !exclude.some(match);
+    }
+    return true;
+  };
+  (0, import_getAllProperties.default)(instance).filter(([key]) => key !== "constructor" && filter(key)).forEach(([key, object]) => {
+    const descriptor = Object.getOwnPropertyDescriptor(object, key);
+    if (descriptor && typeof descriptor.value === "function") {
+      instance[key] = instance[key].bind(instance);
+    }
+  });
+  return instance;
+}
+if (module.exports.default) module.exports = module.exports.default;

package/utils/object/autoBind.d.ts

@@ -3,9 +3,9 @@
  *
  * @param  {Object}               instance          The instance.
  * @param  {Object}               options           Define specific methods to include or exlude.
- * @param  {Array<String|RegExp>} [options.include] Methods to include.
- * @param  {Array<String|RegExp>} [options.exclude] Methods to exclude.
- * @return {Object}                                 The instance.
+ * @param  {Array<string | RegExp>} [options.include] Methods to include.
+ * @param  {Array<string | RegExp>} [options.exclude] Methods to exclude.
+ * @returns {Object}                                 The instance.
  */
 export default function autoBind(instance: any, options: {
     include?: Array<string | RegExp>;

package/utils/object/autoBind.js

@@ -1,34 +1,24 @@
-import getAllProperties from './getAllProperties.js';
-export default function autoBind(instance, options) {
-  var {
-    exclude,
-    include
-  } = options || {};
-
-  var filter = key => {
-    var match = pattern => typeof pattern === 'string' ? key === pattern : pattern.test(key);
-
+import getAllProperties from "./getAllProperties.js";
+function autoBind(instance, options) {
+  const { exclude, include } = options || {};
+  const filter = (key) => {
+    const match = (pattern) => typeof pattern === "string" ? key === pattern : pattern.test(key);
     if (include) {
       return include.some(match);
     }
-
     if (exclude) {
       return !exclude.some(match);
     }
-
     return true;
   };
-
-  getAllProperties(instance).filter(_ref => {
-    var [key] = _ref;
-    return key !== 'constructor' && filter(key);
-  }).forEach(_ref2 => {
-    var [key, object] = _ref2;
-    var descriptor = Object.getOwnPropertyDescriptor(object, key);
-
-    if (descriptor && typeof descriptor.value === 'function') {
+  getAllProperties(instance).filter(([key]) => key !== "constructor" && filter(key)).forEach(([key, object]) => {
+    const descriptor = Object.getOwnPropertyDescriptor(object, key);
+    if (descriptor && typeof descriptor.value === "function") {
       instance[key] = instance[key].bind(instance);
     }
   });
   return instance;
-}
+}
+export {
+  autoBind as default
+};

package/utils/object/getAllProperties.cjs

@@ -0,0 +1,37 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// packages/js-toolkit/utils/object/getAllProperties.js
+var getAllProperties_exports = {};
+__export(getAllProperties_exports, {
+  default: () => getAllProperties
+});
+module.exports = __toCommonJS(getAllProperties_exports);
+function getAllProperties(object, props = [], testFn = null) {
+  const proto = Object.getPrototypeOf(object);
+  if (proto === Object.prototype || proto === null) {
+    return props;
+  }
+  let foundProps = Object.getOwnPropertyNames(proto);
+  if (typeof testFn === "function") {
+    foundProps = foundProps.filter((name) => testFn(name, proto));
+  }
+  foundProps = foundProps.map((name) => [name, proto]).reduce((acc, val) => [...acc, val], props);
+  return getAllProperties(proto, foundProps, testFn);
+}
+if (module.exports.default) module.exports = module.exports.default;

package/utils/object/getAllProperties.d.ts

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

package/utils/object/getAllProperties.js

@@ -1,18 +1,15 @@
-export default function getAllProperties(object) {
-  var props = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
-  var testFn = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : null;
-  var proto = Object.getPrototypeOf(object);
-
+function getAllProperties(object, props = [], testFn = null) {
+  const proto = Object.getPrototypeOf(object);
   if (proto === Object.prototype || proto === null) {
     return props;
   }
-
-  var foundProps = Object.getOwnPropertyNames(proto);
-
-  if (typeof testFn === 'function') {
-    foundProps = foundProps.filter(name => testFn(name, proto));
+  let foundProps = Object.getOwnPropertyNames(proto);
+  if (typeof testFn === "function") {
+    foundProps = foundProps.filter((name) => testFn(name, proto));
   }
-
-  foundProps = foundProps.map(name => [name, proto]).reduce((acc, val) => [...acc, val], props);
+  foundProps = foundProps.map((name) => [name, proto]).reduce((acc, val) => [...acc, val], props);
   return getAllProperties(proto, foundProps, testFn);
-}
+}
+export {
+  getAllProperties as default
+};

package/utils/object/index.cjs

@@ -0,0 +1,33 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target, mod));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// packages/js-toolkit/utils/object/index.js
+var object_exports = {};
+__export(object_exports, {
+  autoBind: () => import_autoBind.default,
+  getAllProperties: () => import_getAllProperties.default,
+  isObject: () => import_isObject.default
+});
+module.exports = __toCommonJS(object_exports);
+var import_autoBind = __toESM(require("./autoBind.cjs"), 1);
+var import_getAllProperties = __toESM(require("./getAllProperties.cjs"), 1);
+var import_isObject = __toESM(require("./isObject.cjs"), 1);
+if (module.exports.default) module.exports = module.exports.default;

package/utils/object/index.js

@@ -1,3 +1,8 @@
-export { default as autoBind } from './autoBind.js';
-export { default as getAllProperties } from './getAllProperties.js';
-export { default as isObject } from './isObject.js';
+import { default as default2 } from "./autoBind.js";
+import { default as default3 } from "./getAllProperties.js";
+import { default as default4 } from "./isObject.js";
+export {
+  default2 as autoBind,
+  default3 as getAllProperties,
+  default4 as isObject
+};

package/utils/object/isObject.cjs

@@ -0,0 +1,28 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// packages/js-toolkit/utils/object/isObject.js
+var isObject_exports = {};
+__export(isObject_exports, {
+  default: () => isObject
+});
+module.exports = __toCommonJS(isObject_exports);
+function isObject(value) {
+  return typeof value === "object" && !!value && value.toString() === "[object Object]";
+}
+if (module.exports.default) module.exports = module.exports.default;

package/utils/object/isObject.d.ts

@@ -2,6 +2,6 @@
  * Test if the given value is an object.
  *
  * @param {*} value The value to test.
- * @return {Boolean} Whether or not the value is an object.
+ * @returns {boolean} Whether or not the value is an object.
  */
 export default function isObject(value: any): boolean;

package/utils/object/isObject.js

@@ -1,3 +1,6 @@
-export default function isObject(value) {
-  return typeof value === 'object' && !!value && value.toString() === '[object Object]';
-}
+function isObject(value) {
+  return typeof value === "object" && !!value && value.toString() === "[object Object]";
+}
+export {
+  isObject as default
+};

package/utils/scrollTo.cjs

@@ -0,0 +1,80 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target, mod));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// packages/js-toolkit/utils/scrollTo.js
+var scrollTo_exports = {};
+__export(scrollTo_exports, {
+  default: () => scrollTo
+});
+module.exports = __toCommonJS(scrollTo_exports);
+var import_damp = __toESM(require("./math/damp.cjs"), 1);
+function scrollTo(selectorElement, { offset = 0, dampFactor = 0.2 } = {}) {
+  let targetElement = null;
+  if (selectorElement instanceof HTMLElement) {
+    targetElement = selectorElement;
+  } else {
+    targetElement = document.querySelector(selectorElement);
+  }
+  if (!targetElement) {
+    return Promise.resolve(window.pageYOffset);
+  }
+  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;
+  }
+  return new Promise((resolve) => {
+    let isScrolling = false;
+    let scroll = window.pageYOffset;
+    let dampScroll = window.pageYOffset;
+    function eventHandler() {
+      isScrolling = false;
+    }
+    function end() {
+      window.removeEventListener("wheel", eventHandler);
+      window.removeEventListener("touchmove", eventHandler);
+      resolve(window.pageYOffset);
+    }
+    function loop() {
+      if (!isScrolling) {
+        return end();
+      }
+      dampScroll = (0, import_damp.default)(scroll, dampScroll, dampFactor);
+      window.scrollTo({ top: dampScroll });
+      if (dampScroll === scroll) {
+        isScrolling = false;
+      }
+      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);
+  });
+}
+if (module.exports.default) module.exports = module.exports.default;

package/utils/scrollTo.d.ts

@@ -3,7 +3,7 @@
  *
  * @param {HTMLElement|string} selectorElement The target element.
  * @param {{ offset?: number, dampFactor?: number }} [options] Options for the scroll.
- * @return {Promise<number>} A promising resolving with the target scroll position.
+ * @returns {Promise<number>} A promising resolving with the target scroll position.
  */
 export default function scrollTo(selectorElement: HTMLElement | string, { offset, dampFactor }?: {
     offset?: number;