0
0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
puppeteer/docs/api/puppeteer.httprequest.respond.md
jrandolf f07ad2c661
fix: update documentation on configuring puppeteer ()
This PR updates the docs regarding configuring puppeteer. In addition,
some changes have been made to the documentation generator to show
default values on the documentation site.

Also fixes: https://github.com/puppeteer/puppeteer/pull/9144
2022-10-24 09:07:05 +02:00

53 lines
1.8 KiB
Markdown

---
sidebar_label: HTTPRequest.respond
---
# HTTPRequest.respond() method
Fulfills a request with the given response.
#### Signature:
```typescript
class HTTPRequest {
respond(
response: Partial<ResponseForRequest>,
priority?: number
): Promise<void>;
}
```
## Parameters
| Parameter | Type | Description |
| --------- | ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| response | Partial&lt;[ResponseForRequest](./puppeteer.responseforrequest.md)&gt; | the response to fulfill the request with. |
| priority | number | <i>(Optional)</i> If provided, intercept is resolved using cooperative handling rules. Otherwise, intercept is resolved immediately. |
**Returns:**
Promise&lt;void&gt;
## Remarks
To use this, request interception should be enabled with [Page.setRequestInterception()](./puppeteer.page.setrequestinterception.md).
Exception is immediately thrown if the request interception is not enabled.
## Example
An example of fulfilling all requests with 404 responses:
```ts
await page.setRequestInterception(true);
page.on('request', request => {
request.respond({
status: 404,
contentType: 'text/plain',
body: 'Not Found!',
});
});
```
NOTE: Mocking responses for dataURL requests is not supported. Calling `request.respond` for a dataURL request is a noop.