🤖 Merge PR DefinitelyTyped#73834 feat(selenium-webdriver): add jsdoc for urlPattern, simplify test by @hkleungai

Author: hkleungai

types/selenium-webdriver/bidi/urlPattern.d.ts

@@ -1,12 +1,42 @@
+/**
+ * Represents a URL pattern to intercept.
+ * Described in network.UrlPatternPattern https://w3c.github.io/webdriver-bidi/#type-network-UrlPattern
+ */
 declare class UrlPattern {
+    /**
+     * Sets the protocol for the URL pattern.
+     * @param protocol - The protocol to set.
+     * @returns Returns the updated instance of the URL pattern for chaining.
+     */
     protocol(protocol: string): UrlPattern;
 
+    /**
+     * Sets the hostname for the URL pattern.
+     * @param hostname - The hostname to set.
+     * @returns Returns the updated instance of the URL pattern for chaining.
+     */
     hostname(hostname: string): UrlPattern;
 
+    /**
+     * Sets the port for the URL pattern.
+     * @param port - The port number to set.
+     * @returns Returns the updated instance of the URL pattern for chaining.
+     * @throws Throws an error if the port is not a number.
+     */
     port(port: number): UrlPattern;
 
+    /**
+     * Sets the pathname for the URL pattern.
+     * @param pathname - The pathname to set.
+     * @returns Returns the updated instance of the URL pattern for chaining.
+     */
     pathname(pathname: string): UrlPattern;
 
+    /**
+     * Sets the search parameter in the URL pattern.
+     * @param search - The search parameter to be set.
+     * @returns Returns the updated instance of the URL pattern for chaining.
+     */
     search(search: string): UrlPattern;
 
     asMap(): Map<string, string>;

types/selenium-webdriver/test/bidi/urlPattern.ts

@@ -1,75 +1,13 @@
 import { UrlPattern } from "selenium-webdriver/bidi/urlPattern";
 
-function testMethodChaining() {
-    const urlPattern = new UrlPattern()
-        .protocol("https")
-        .hostname("example.com")
-        .port(8080)
-        .pathname("/home")
-        .search("?query=123");
+let urlPattern: UrlPattern;
 
-    if (!(urlPattern instanceof UrlPattern)) {
-        console.error("Failed: Method chaining does not return UrlPattern");
-    } else {
-        console.log("Passed: Method chaining works as expected");
-    }
-}
+urlPattern = new UrlPattern()
+    .protocol("https")
+    .hostname("example.com")
+    .port(8080)
+    .pathname("/home")
+    .search("?query=123");
 
-function testAsMap() {
-    const urlPattern = new UrlPattern()
-        .protocol("https")
-        .hostname("example.com")
-        .port(8080)
-        .pathname("/home")
-        .search("?query=123");
-
-    const map = urlPattern.asMap();
-    if (!(map instanceof Map)) {
-        console.error("Failed: asMap() does not return a Map");
-    } else if (map.get("protocol") !== "https" || map.get("hostname") !== "example.com") {
-        console.error("Failed: Map does not contain expected values");
-    } else {
-        console.log("Passed: asMap() returns the correct Map with expected values");
-    }
-}
-
-function testParameterTypes() {
-    const urlPattern = new UrlPattern();
-
-    try {
-        urlPattern.protocol("http"); // Valid type
-        urlPattern.hostname("localhost"); // Valid type
-        urlPattern.port(8080); // Valid type
-        urlPattern.pathname("/test"); // Valid type
-        urlPattern.search("?id=123"); // Valid type
-
-        console.log("Passed: Method parameters are correctly typed");
-    } catch (e) {
-        console.error("Failed: Method parameters typing issue", e);
-    }
-}
-
-function testMapTypes() {
-    const urlPattern = new UrlPattern()
-        .protocol("https")
-        .hostname("example.com")
-        .port(8080)
-        .pathname("/home")
-        .search("?query=123");
-
-    const result = urlPattern.asMap();
-    const protocol = result.get("protocol");
-    const port = result.get("port");
-
-    if (typeof protocol !== "string" || typeof port !== "string") {
-        console.error("Failed: Map return types are not correct");
-    } else {
-        console.log("Passed: Map return types are correct");
-    }
-}
-
-// Run tests
-testMethodChaining();
-testAsMap();
-testParameterTypes();
-testMapTypes();
+// $ExpectType Map<string, string>
+urlPattern.asMap();