puppeteer/website/versioned_docs/version-20.9.0/api/puppeteer.httprequest.abort.md

31 lines
1.2 KiB
Markdown
Raw Normal View History

---
sidebar_label: HTTPRequest.abort
---
# HTTPRequest.abort() method
Aborts a request.
2022-10-24 14:31:12 +00:00
#### Signature:
```typescript
class HTTPRequest {
abort(errorCode?: ErrorCode, priority?: number): Promise<void>;
}
```
## Parameters
| Parameter | Type | Description |
| --------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| errorCode | [ErrorCode](./puppeteer.errorcode.md) | _(Optional)_ optional error code to provide. |
| priority | number | _(Optional)_ 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). If it is not enabled, this method will throw an exception immediately.