Skip to main content
Version: 3.0

puppeteerUtils

A namespace that contains various utilities for Puppeteer - the headless Chrome Node API.

Example usage:

import { launchPuppeteer, puppeteerUtils } from 'crawlee';

// Open https://www.example.com in Puppeteer
const browser = await launchPuppeteer();
const page = await browser.newPage();
await page.goto('https://www.example.com');

// Inject jQuery into a page
await puppeteerUtils.injectJQuery(page);

Index

References

Interfaces

Type Aliases

Functions

References

addInterceptRequestHandler

Re-exports addInterceptRequestHandler

removeInterceptRequestHandler

Re-exports removeInterceptRequestHandler

Interfaces

BlockRequestsOptions

BlockRequestsOptions:

optionalextraUrlPatterns

extraUrlPatterns?: string[]

If you just want to append to the default blocked patterns, use this property.

optionalurlPatterns

urlPatterns?: string[]

The patterns of URLs to block from being loaded by the browser. Only * can be used as a wildcard. It is also automatically added to the beginning and end of the pattern. This limitation is enforced by the DevTools protocol. .png is the same as *.png*.

CompiledScriptParams

CompiledScriptParams:

page

page: Page

request

request: Request<Dictionary<any>>

DirectNavigationOptions

DirectNavigationOptions:

optionalreferer

referer?: string

Referer header value. If provided it will take preference over the referer header value set by page.setExtraHTTPHeaders(headers).

optionaltimeout

timeout?: number

Maximum operation time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultNavigationTimeout(timeout), browserContext.setDefaultTimeout(timeout), page.setDefaultNavigationTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

optionalwaitUntil

waitUntil?: domcontentloaded | load | networkidle

When to consider operation succeeded, defaults to load. Events can be either:

  • 'domcontentloaded' - consider operation to be finished when the DOMContentLoaded event is fired.
  • 'load' - consider operation to be finished when the load event is fired.
  • 'networkidle' - consider operation to be finished when there are no network connections for at least 500 ms.

InfiniteScrollOptions

InfiniteScrollOptions:

optionalbuttonSelector

buttonSelector?: string

Optionally checks and clicks a button if it appears while scrolling. This is required on some websites for the scroll to work.

optionalscrollDownAndUp

scrollDownAndUp?: boolean = <p>false</p>

If true, it will scroll up a bit after each scroll down. This is required on some websites for the scroll to work.

optionalstopScrollCallback

stopScrollCallback?: () => unknown

Type declaration

    • (): unknown

    • This function is called after every scroll and stops the scrolling process if it returns true. The function can be async.

      Returns unknown

optionaltimeoutSecs

timeoutSecs?: number = <p>1</p>

How many seconds to scroll for. If 0, will scroll until bottom of page.

optionalwaitForSecs

waitForSecs?: number = <p>4</p>

How many seconds to wait for no new content to load before exit.

InjectFileOptions

InjectFileOptions:

optionalsurviveNavigations

surviveNavigations?: boolean

Enables the injected script to survive page navigations and reloads without need to be re-injected manually. This does not mean, however, that internal state will be preserved. Just that it will be automatically re-injected on each navigation before any other scripts get the chance to execute.

PuppeteerContextUtils

PuppeteerContextUtils:

addInterceptRequestHandler

blockRequests

blockResources

  • blockResources(resourceTypes?: string[]): Promise<void>

  • Parameters

    • optionalresourceTypes: string[]

    Returns Promise<void>

cacheResponses

  • cacheResponses(cache: Dictionary<Partial<ResponseForRequest>>, responseUrlRules: (string | RegExp)[]): Promise<void>

  • Parameters

    • cache: Dictionary<Partial<ResponseForRequest>>
    • responseUrlRules: (string | RegExp)[]

    Returns Promise<void>

compileScript

enqueueLinksByClickingElements

infiniteScroll

injectFile

injectJQuery

  • injectJQuery(): Promise<unknown>

  • Returns Promise<unknown>

parseWithCheerio

  • parseWithCheerio(): Promise<CheerioAPI>

  • Returns Promise<CheerioAPI>

removeInterceptRequestHandler

saveSnapshot

SaveSnapshotOptions

SaveSnapshotOptions:

optionalkey

key?: string = <p>‘SNAPSHOT’</p>

Key under which the screenshot and HTML will be saved. .jpg will be appended for screenshot and .html for HTML.

optionalkeyValueStoreName

keyValueStoreName?: null | string = null | string

Name or id of the Key-Value store where snapshot is saved. By default it is saved to default Key-Value store.

optionalsaveHtml

saveHtml?: boolean = <p>true</p>

If true, it will save a full HTML of the current page as a record with key appended by .html.

optionalsaveScreenshot

saveScreenshot?: boolean = <p>true</p>

If true, it will save a full screenshot of the current page as a record with key appended by .jpg.

optionalscreenshotQuality

screenshotQuality?: number = <p>50</p>

The quality of the image, between 0-100. Higher quality images have bigger size and require more storage.

Type Aliases

CompiledScriptFunction

CompiledScriptFunction: (params: CompiledScriptParams) => Promise<unknown>

Type declaration

Functions

blockRequests

  • Forces the Puppeteer browser tab to block loading URLs that match a provided pattern. This is useful to speed up crawling of websites, since it reduces the amount of data that needs to be downloaded from the web, but it may break some websites or unexpectedly prevent loading of resources.

    By default, the function will block all URLs including the following patterns:

    [".css", ".jpg", ".jpeg", ".png", ".svg", ".gif", ".woff", ".pdf", ".zip"]

    If you want to extend this list further, use the extraUrlPatterns option, which will keep blocking the default patterns, as well as add your custom ones. If you would like to block only specific patterns, use the urlPatterns option, which will override the defaults and block only URLs with your custom patterns.

    This function does not use Puppeteer's request interception and therefore does not interfere with browser cache. It's also faster than blocking requests using interception, because the blocking happens directly in the browser without the round-trip to Node.js, but it does not provide the extra benefits of request interception.

    The function will never block main document loads and their respective redirects.

    Example usage

    import { launchPuppeteer, puppeteerUtils } from 'crawlee';

    const browser = await launchPuppeteer();
    const page = await browser.newPage();

    // Block all requests to URLs that include `adsbygoogle.js` and also all defaults.
    await puppeteerUtils.blockRequests(page, {
        extraUrlPatterns: ['adsbygoogle.js'],
    });

    await page.goto('https://cnn.com');

    Parameters

    Returns Promise<void>

blockResources

  • blockResources(page: Page, resourceTypes?: string[]): Promise<void>

  • blockResources() has a high impact on performance in recent versions of Puppeteer. Until this resolves, please use utils.puppeteer.blockRequests().

    @deprecated

    Parameters

    • page: Page
    • resourceTypes: string[] = ...

    Returns Promise<void>

cacheResponses

  • cacheResponses(page: Page, cache: Dictionary<Partial<ResponseForRequest>>, responseUrlRules: (string | RegExp)[]): Promise<void>

  • NOTE: In recent versions of Puppeteer using this function entirely disables browser cache which resolves in sub-optimal performance. Until this resolves, we suggest just relying on the in-browser cache unless absolutely necessary.

    Enables caching of intercepted responses into a provided object. Automatically enables request interception in Puppeteer. IMPORTANT: Caching responses stores them to memory, so too loose rules could cause memory leaks for longer running crawlers. This issue should be resolved or atleast mitigated in future iterations of this feature.

    @deprecated

    Parameters

    • page: Page

      Puppeteer Page object.

    • cache: Dictionary<Partial<ResponseForRequest>>

      Object in which responses are stored

    • responseUrlRules: (string | RegExp)[]

      List of rules that are used to check if the response should be cached. String rules are compared as page.url().includes(rule) while RegExp rules are evaluated as rule.test(page.url()).

    Returns Promise<void>

compileScript

  • Compiles a Puppeteer script into an async function that may be executed at any time by providing it with the following object:

    {
       page: Page,
       request: Request,
    }

    Where page is a Puppeteer Page and request is a Request.

    The function is compiled by using the scriptString parameter as the function's body, so any limitations to function bodies apply. Return value of the compiled function is the return value of the function body = the scriptString parameter.

    As a security measure, no globals such as process or require are accessible from within the function body. Note that the function does not provide a safe sandbox and even though globals are not easily accessible, malicious code may still execute in the main process via prototype manipulation. Therefore you should only use this function to execute sanitized or safe code.

    Custom context may also be provided using the context parameter. To improve security, make sure to only pass the really necessary objects to the context. Preferably making secured copies beforehand.

    Parameters

    • scriptString: string
    • context: Dictionary<any> = ...

    Returns CompiledScriptFunction

enqueueLinksByClickingElements

  • The function finds elements matching a specific CSS selector in a Puppeteer page, clicks all those elements using a mouse move and a left mouse button click and intercepts all the navigation requests that are subsequently produced by the page. The intercepted requests, including their methods, headers and payloads are then enqueued to a provided RequestQueue. This is useful to crawl JavaScript heavy pages where links are not available in href elements, but rather navigations are triggered in click handlers. If you're looking to find URLs in href attributes of the page, see enqueueLinks.

    Optionally, the function allows you to filter the target links' URLs using an array of PseudoUrl objects and override settings of the enqueued Request objects.

    IMPORTANT: To be able to do this, this function uses various mutations on the page, such as changing the Z-index of elements being clicked and their visibility. Therefore, it is recommended to only use this function as the last operation in the page.

    USING HEADFUL BROWSER: When using a headful browser, this function will only be able to click elements in the focused tab, effectively limiting concurrency to 1. In headless mode, full concurrency can be achieved.

    PERFORMANCE: Clicking elements with a mouse and intercepting requests is not a low level operation that takes nanoseconds. It's not very CPU intensive, but it takes time. We strongly recommend limiting the scope of the clicking as much as possible by using a specific selector that targets only the elements that you assume or know will produce a navigation. You can certainly click everything by using the * selector, but be prepared to wait minutes to get results on a large and complex page.

    Example usage

    await utils.puppeteer.enqueueLinksByClickingElements({
      page,
      requestQueue,
      selector: 'a.product-detail',
      pseudoUrls: [
          'https://www.example.com/handbags/[.*]'
          'https://www.example.com/purses/[.*]'
      ],
    });

    Parameters

    Returns Promise<BatchAddRequestsResult>

    Promise that resolves to BatchAddRequestsResult object.

gotoExtended

  • Extended version of Puppeteer's page.goto() allowing to perform requests with HTTP method other than GET, with custom headers and POST payload. URL, method, headers and payload are taken from request parameter that must be an instance of Request class.

    NOTE: In recent versions of Puppeteer using requests other than GET, overriding headers and adding payloads disables browser cache which degrades performance.

    Parameters

    Returns Promise<HTTPResponse | null>

infiniteScroll

  • Scrolls to the bottom of a page, or until it times out. Loads dynamic content when it hits the bottom of a page, and then continues scrolling.

    Parameters

    Returns Promise<void>

injectFile

  • injectFile(page: Page, filePath: string, options?: InjectFileOptions): Promise<unknown>

  • Injects a JavaScript file into a Puppeteer page. Unlike Puppeteer's addScriptTag function, this function works on pages with arbitrary Cross-Origin Resource Sharing (CORS) policies.

    File contents are cached for up to 10 files to limit file system access.

    Parameters

    Returns Promise<unknown>

injectJQuery

  • injectJQuery(page: Page): Promise<unknown>

  • Injects the jQuery library into a Puppeteer page. jQuery is often useful for various web scraping and crawling tasks. For example, it can help extract text from HTML elements using CSS selectors.

    Beware that the injected jQuery object will be set to the window.$ variable and thus it might cause conflicts with other libraries included by the page that use the same variable name (e.g. another version of jQuery). This can affect functionality of page's scripts.

    The injected jQuery will survive page navigations and reloads.

    Example usage:

    await puppeteerUtils.injectJQuery(page);
    const title = await page.evaluate(() => {
      return $('head title').text();
    });

    Note that injectJQuery() does not affect the Puppeteer's page.$() function in any way.

    Parameters

    • page: Page

      Puppeteer Page object.

    Returns Promise<unknown>

parseWithCheerio

  • Returns Cheerio handle for page.content(), allowing to work with the data same way as with CheerioCrawler.

    Example usage:

    const $ = await puppeteerUtils.parseWithCheerio(page);
    const title = $('title').text();

    Parameters

    • page: Page

      Puppeteer Page object.

    Returns Promise<CheerioRoot>

saveSnapshot

  • Saves a full screenshot and HTML of the current page into a Key-Value store.

    Parameters

    Returns Promise<void>

Page Options