puppeteer/docs/api/puppeteer.httprequest.abort.md
jrandolf f07ad2c661
fix: update documentation on configuring puppeteer (#9150)
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

1.2 KiB

sidebar_label
HTTPRequest.abort

HTTPRequest.abort() method

Aborts a request.

Signature:

class HTTPRequest {
  abort(errorCode?: ErrorCode, priority?: number): Promise<void>;
}

Parameters

Parameter Type Description
errorCode ErrorCode (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<void>

Remarks

To use this, request interception should be enabled with Page.setRequestInterception(). If it is not enabled, this method will throw an exception immediately.