f07ad2c661
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
31 lines
1.2 KiB
Markdown
31 lines
1.2 KiB
Markdown
---
|
|
sidebar_label: HTTPRequest.abort
|
|
---
|
|
|
|
# HTTPRequest.abort() method
|
|
|
|
Aborts a request.
|
|
|
|
#### Signature:
|
|
|
|
```typescript
|
|
class HTTPRequest {
|
|
abort(errorCode?: ErrorCode, priority?: number): Promise<void>;
|
|
}
|
|
```
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| errorCode | [ErrorCode](./puppeteer.errorcode.md) | <i>(Optional)</i> optional error code to provide. |
|
|
| priority | number | <i>(Optional)</i> If provided, intercept is resolved using cooperative handling rules. Otherwise, intercept is resolved immediately. |
|
|
|
|
**Returns:**
|
|
|
|
Promise<void>
|
|
|
|
## Remarks
|
|
|
|
To use this, request interception should be enabled with [Page.setRequestInterception()](./puppeteer.page.setrequestinterception.md). If it is not enabled, this method will throw an exception immediately.
|