puppeteer/new-docs/puppeteer.page.setrequestinterception.md
Changhao Han adeffbaac1
docs(new): migrate Page.ts to TSDoc (part 0 / 2) (#6104)
* docs(new): migrate Page.ts to TSDoc (part 0 / 2)

Co-authored-by: Changhao Han <changhaohan@chromium.org>
2020-06-26 09:24:56 +02:00

1.7 KiB

Home > puppeteer > Page > setRequestInterception

Page.setRequestInterception() method

Signature:

setRequestInterception(value: boolean): Promise<void>;

Parameters

Parameter Type Description
value boolean Whether to enable request interception.

Returns:

Promise<void>

Remarks

Activating request interception enables HTTPRequest.abort(), HTTPRequest.continue() and HTTPRequest.respond() methods. This provides the capability to modify network requests that are made by a page.

Once request interception is enabled, every request will stall unless it's continued, responded or aborted.

**NOTE** Enabling request interception disables page caching.

Example

An example of a naïve request interceptor that aborts all image requests:

const puppeteer = require('puppeteer');
(async () => {
  const browser = await puppeteer.launch();
  const page = await browser.newPage();
  await page.setRequestInterception(true);
  page.on('request', interceptedRequest => {
    if (interceptedRequest.url().endsWith('.png') ||
        interceptedRequest.url().endsWith('.jpg'))
      interceptedRequest.abort();
    else
      interceptedRequest.continue();
    });
  await page.goto('https://example.com');
  await browser.close();
})();