puppeteer/website/versioned_docs/version-15.4.0/api/puppeteer.page.setrequestinterception.md
release-please[bot] f0c28085c0
chore(main): release 15.4.0 (#8668)
* chore(main): release 15.4.0

* chore: generate versioned docs

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2022-07-13 15:52:23 +02:00

1.5 KiB

sidebar_label
Page.setRequestInterception

Page.setRequestInterception() method

Signature:

class Page {
  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; or completed using the browser cache.

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();
})();

NOTE: Enabling request interception disables page caching.