@tb-dev/prototype-dom 6.3.1 → 7.0.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export declare interface ScrollAsyncOptions extends ScrollIntoViewOptions {
+export declare interface WaitScrollOptions extends ScrollIntoViewOptions {
     timeout?: number;
     /** @default true */
     throwOnTimeout?: boolean;
@@ -45,17 +45,17 @@ declare global {
         queryAsMap: <T extends Element, K, V = T>(selector: string, keyFn: (element: T) => K, valueFn?: (element: T) => V) => Map<K, V>;
         /**
          * Wait for the first descendant element that matches the given selector to exist.
-         * Once found, scroll the element into view.
          * @param selector CSS selector to match.
-         * @param options Options to customize the scrolling behavior.
+         * @param timeout Maximum time to wait for the element, in milliseconds.
          */
-        scrollAsync: (selector: string, options?: ScrollAsyncOptions) => Promise<void>;
+        waitChild: (selector: string, timeout?: number) => Promise<Element>;
         /**
          * Wait for the first descendant element that matches the given selector to exist.
+         * Once found, scroll the element into view.
          * @param selector CSS selector to match.
-         * @param timeout Maximum time to wait for the element, in milliseconds.
+         * @param options Options to customize the scrolling behavior.
          */
-        waitChild: (selector: string, timeout?: number) => Promise<Element>;
+        waitScroll: (selector: string, options?: WaitScrollOptions) => Promise<void>;
     }
     interface Element {
         /**
@@ -141,17 +141,17 @@ declare global {
         queryAsMap: <T extends Element, K, V = T>(selector: string, keyFn: (element: T) => K, valueFn?: (element: T) => V) => Map<K, V>;
         /**
          * Wait for the first descendant element that matches the given selector to exist.
-         * Once found, scroll the element into view.
          * @param selector CSS selector to match.
-         * @param options Options to customize the scrolling behavior.
+         * @param timeout Maximum time to wait for the element, in milliseconds.
          */
-        scrollAsync: (selector: string, options?: ScrollAsyncOptions) => Promise<void>;
+        waitChild: (selector: string, timeout?: number) => Promise<Element>;
         /**
          * Wait for the first descendant element that matches the given selector to exist.
+         * Once found, scroll the element into view.
          * @param selector CSS selector to match.
-         * @param timeout Maximum time to wait for the element, in milliseconds.
+         * @param options Options to customize the scrolling behavior.
          */
-        waitChild: (selector: string, timeout?: number) => Promise<Element>;
+        waitScroll: (selector: string, options?: WaitScrollOptions) => Promise<void>;
     }
     interface URLSearchParams {
         /**

package/dist/index.iife.js

@@ -113,7 +113,7 @@
       return promise;
     };
   }
-  function scrollAsync() {
+  function waitScroll() {
     return async function(selector, options = {}) {
       const { timeout, throwOnTimeout = true, ...scrollOptions } = options;
       try {
@@ -140,8 +140,8 @@
     queryAsArray,
     queryAsSet,
     queryAsMap,
-    scrollAsync,
-    waitChild
+    waitChild,
+    waitScroll
   };
 
   function getStrict() {
@@ -181,7 +181,7 @@
   Document.prototype.queryAsArray = element.queryAsArray();
   Document.prototype.queryAsSet = element.queryAsSet();
   Document.prototype.queryAsMap = element.queryAsMap();
-  Document.prototype.scrollAsync = element.scrollAsync();
+  Document.prototype.waitScroll = element.waitScroll();
   Document.prototype.waitChild = element.waitChild();
   Element.prototype.getAttributeStrict = element.getAttributeStrict();
   Element.prototype.getAttributeAsFloatStrict = element.getAttributeAsFloatStrict();
@@ -193,7 +193,7 @@
   Element.prototype.queryAsArray = element.queryAsArray();
   Element.prototype.queryAsSet = element.queryAsSet();
   Element.prototype.queryAsMap = element.queryAsMap();
-  Element.prototype.scrollAsync = element.scrollAsync();
+  Element.prototype.waitScroll = element.waitScroll();
   Element.prototype.waitChild = element.waitChild();
   URLSearchParams.prototype.getStrict = urlSearchParams.getStrict();
   URLSearchParams.prototype.getAsInteger = urlSearchParams.getAsInteger();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tb-dev/prototype-dom",
-  "version": "6.3.1",
+  "version": "7.0.0",
   "description": "Prototype methods for DOM objects",
   "license": "MIT",
   "type": "module",
@@ -18,21 +18,16 @@
     "url": "https://github.com/ferreira-tb/prototype-dom/issues",
     "email": "andrew.shien2@gmail.com"
   },
-  "lint-staged": {
-    "*.{?(c|m)@(j|t)s,css,vue,md,json}": "prettier --write"
-  },
   "devDependencies": {
-    "@tb-dev/eslint-config": "^5.3.3",
-    "eslint": "^9.11.1",
-    "husky": "^9.1.6",
-    "lint-staged": "^15.2.10",
+    "@tb-dev/eslint-config": "^5.4.9",
+    "eslint": "^9.13.0",
     "prettier": "^3.3.3",
-    "tslib": "^2.7.0",
-    "typedoc": "^0.26.7",
-    "typedoc-plugin-mdn-links": "^3.3.2",
-    "typescript": "^5.6.2",
-    "vite": "^5.4.8",
-    "vite-plugin-dts": "^4.2.3"
+    "tslib": "^2.8.0",
+    "typedoc": "^0.26.10",
+    "typedoc-plugin-mdn-links": "^3.3.4",
+    "typescript": "^5.6.3",
+    "vite": "^5.4.10",
+    "vite-plugin-dts": "^4.3.0"
   },
   "files": [
     "dist/**/*"