chore: type in waitForRequest function description (#9015)

puppeteer · Oct 4, 2022 · 5dbd69e · 5dbd69e
1 parent c0c7878
commit 5dbd69e
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 20 deletions.
diff --git a/docs/api/puppeteer.page.waitforrequest.md b/docs/api/puppeteer.page.waitforrequest.md
@@ -28,7 +28,7 @@ class Page {
 
 Promise&lt;[HTTPRequest](./puppeteer.httprequest.md)&gt;
 
-Promise which resolves to the matched response
+Promise which resolves to the matched request
 
 ## Remarks
 
@@ -39,15 +39,9 @@ Optional Waiting Parameters have:
 ## Example
 
 ```ts
-const firstResponse = await page.waitForResponse(
-  'https://example.com/resource'
+const firstRequest = await page.waitForRequest('https://example.com/resource');
+const finalRequest = await page.waitForRequest(
+  request => request.url() === 'https://example.com'
 );
-const finalResponse = await page.waitForResponse(
-  response =>
-    response.url() === 'https://example.com' && response.status() === 200
-);
-const finalResponse = await page.waitForResponse(async response => {
-  return (await response.text()).includes('<html>');
-});
-return finalResponse.ok();
+return finalRequest.response()?.ok();
 ```
diff --git a/src/api/Page.ts b/src/api/Page.ts
@@ -1478,21 +1478,17 @@ export class Page extends EventEmitter {
   /**
    * @param urlOrPredicate - A URL or predicate to wait for
    * @param options - Optional waiting parameters
-   * @returns Promise which resolves to the matched response
+   * @returns Promise which resolves to the matched request
    * @example
    *
    * ```ts
-   * const firstResponse = await page.waitForResponse(
+   * const firstRequest = await page.waitForRequest(
    *   'https://example.com/resource'
    * );
-   * const finalResponse = await page.waitForResponse(
-   *   response =>
-   *     response.url() === 'https://example.com' && response.status() === 200
+   * const finalRequest = await page.waitForRequest(
+   *   request => request.url() === 'https://example.com'
    * );
-   * const finalResponse = await page.waitForResponse(async response => {
-   *   return (await response.text()).includes('<html>');
-   * });
-   * return finalResponse.ok();
+   * return finalRequest.response()?.ok();
    * ```
    *
    * @remarks