docs: add page for waitForResponse mock method (#14834)

icholy · web-flow · commit fb21998d7a4b · 2025-11-13T21:23:56.000-08:00
diff --git a/packages/webdriverio/src/commands/mock/waitForResponse.ts b/packages/webdriverio/src/commands/mock/waitForResponse.ts
@@ -0,0 +1,25 @@
+/**
+ * Wait until at least one matching request has received a response.
+ *
+ * <example>
+    :waitForResponse.js
+    it('should wait for a matching response', async () => {
+        const mock = await browser.mock('**/api/**')
+
+        // trigger action that issues the request
+        await $('#load').click()
+
+        await mock.waitForResponse({ timeout: 5000 })
+        expect(mock.calls.length).toBeGreaterThan(0)
+    })
+ * </example>
+ *
+ * @alias mock.waitForResponse
+ * @param {WaitForOptions=}  options                 wait options
+ * @param {Number=}          options.timeout         max wait time in ms (defaults to `browser.options.waitforTimeout`)
+ * @param {Number=}          options.interval        poll interval in ms (defaults to `browser.options.waitforInterval`)
+ * @param {String=}          options.timeoutMsg      custom timeout error message
+ */
+// actual implementation is located in packages/webdriverio/src/utils/interception
+
+
diff --git a/website/docs/MocksAndSpies.md b/website/docs/MocksAndSpies.md
@@ -187,3 +187,5 @@ expect(mock.calls.length).toBe(1)
 // assert response
 expect(mock.calls[0].body).toEqual({ success: true })
 ```
+
+If you need to wait until a matching request has responded, use `mock.waitForResponse(options)`. See the API reference: [waitForResponse](/docs/api/mock/waitForResponse).
diff --git a/website/docs/api/Mock.md b/website/docs/api/Mock.md
@@ -39,6 +39,7 @@ Mock objects provide various commands, listed in the `mock` section, that allow
 - [`respond`](/docs/api/mock/respond)
 - [`respondOnce`](/docs/api/mock/respondOnce)
 - [`restore`](/docs/api/mock/restore)
+- [`waitForResponse`](/docs/api/mock/waitForResponse)
 
 ## Events
 
