mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
56 lines
1.8 KiB
Markdown
56 lines
1.8 KiB
Markdown
|
---
|
||
|
sidebar_label: Page.waitForResponse
|
||
|
---
|
||
|
|
||
|
# Page.waitForResponse() method
|
||
|
|
||
|
**Signature:**
|
||
|
|
||
|
```typescript
|
||
|
class Page {
|
||
|
waitForResponse(
|
||
|
urlOrPredicate:
|
||
|
| string
|
||
|
| ((res: HTTPResponse) => boolean | Promise<boolean>),
|
||
|
options?: {
|
||
|
timeout?: number;
|
||
|
}
|
||
|
): Promise<HTTPResponse>;
|
||
|
}
|
||
|
```
|
||
|
|
||
|
## Parameters
|
||
|
|
||
|
| Parameter | Type | Description |
|
||
|
| -------------- | ------------------------------------------------------------------------------------------------------ | --------------------------------------------- |
|
||
|
| urlOrPredicate | string \| ((res: [HTTPResponse](./puppeteer.httpresponse.md)) => boolean \| Promise<boolean>) | A URL or predicate to wait for. |
|
||
|
| options | { timeout?: number; } | <i>(Optional)</i> Optional waiting parameters |
|
||
|
|
||
|
**Returns:**
|
||
|
|
||
|
Promise<[HTTPResponse](./puppeteer.httpresponse.md)>
|
||
|
|
||
|
Promise which resolves to the matched response.
|
||
|
|
||
|
## Remarks
|
||
|
|
||
|
Optional Parameter have:
|
||
|
|
||
|
- `timeout`: Maximum wait time in milliseconds, defaults to `30` seconds, pass `0` to disable the timeout. The default value can be changed by using the [Page.setDefaultTimeout()](./puppeteer.page.setdefaulttimeout.md) method.
|
||
|
|
||
|
## Example
|
||
|
|
||
|
```ts
|
||
|
const firstResponse = await page.waitForResponse(
|
||
|
'https://example.com/resource'
|
||
|
);
|
||
|
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();
|
||
|
```
|