puppeteer/new-docs/puppeteer.httprequest.respond.md
Jack Franklin f7857d27c4
chore(docs): document HTTPRequest with TSDoc (#6146)
* chore(docs): document HTTPRequest with TSDoc

* doclint

* example
2020-07-03 14:28:45 +01:00

48 lines
1.3 KiB
Markdown

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [HTTPRequest](./puppeteer.httprequest.md) &gt; [respond](./puppeteer.httprequest.respond.md)
## HTTPRequest.respond() method
Fulfills a request with the given response.
<b>Signature:</b>
```typescript
respond(response: ResponseForRequest): Promise<void>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| response | [ResponseForRequest](./puppeteer.responseforrequest.md) | the response to fulfill the request with. |
<b>Returns:</b>
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:
```js
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.