twd-js 1.2.1 → 1.2.3

package/dist/index.d.ts

@@ -243,16 +243,20 @@ declare interface TWDAPI {
     /**
      * Wait for a mocked request to be made.
      * @param alias The alias of the mock rule to wait for
+     * @param retries The number of retries to make
+     * @param retryDelay The delay between retries
      * @return The matched rule (with body if applicable)
      *
      * @example
      * ```ts
      * const rule = await twd.waitFor("aliasId");
      * console.log(rule.body);
+     * const rule = await twd.waitFor("aliasId", 5, 100);
+     * console.log(rule.body);
      *
      * ```
      */
-    waitForRequest: (alias: string) => Promise<Rule>;
+    waitForRequest: (alias: string, retries?: number, retryDelay?: number) => Promise<Rule>;
     /**
      * wait for a list of mocked requests to be made.
      * @param aliases The aliases of the mock rules to wait for
@@ -276,15 +280,16 @@ declare interface TWDAPI {
     url: () => URLCommandAPI;
     /**
      * Initializes request mocking (registers the service worker).
-     * Must be called before using `twd.mockRequest()`.
+     * @param [path] service worker absolute path (optional)
      *
      * @example
      * ```ts
      * await twd.initRequestMocking();
-     *
+     * // init with custom service worker path
+     * await twd.initRequestMocking('/test-path/mock-sw.js');
      * ```
      */
-    initRequestMocking: () => Promise<void>;
+    initRequestMocking: (path?: string) => Promise<void>;
     /**
      * Clears all request mock rules.
      *
@@ -423,7 +428,7 @@ declare type URLAssertionName = "eq" | "contain.url";
 
 declare type URLCommandAPI = {
     location: Location;
-    should: (name: AnyURLAssertion, value: string) => URLCommandAPI | string;
+    should: (name: AnyURLAssertion, value: string, retries?: number) => Promise<string>;
 };
 
 declare type UserEvent = typeof default_2;