github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
c8bb11adfc
puppeteer/docs/api/puppeteer.elementhandle.screenshot.md
Alex Rudenko 6847f8835f
fix: improve screenshot method types (#9529) 
The only drawback of adding overrides is that our documentation
generator would generate a page for each overload which might be hard to
read/find on the documentation website.

Closes #9512 #9385
2023-01-18 14:06:20 +00:00

873 B
Raw Blame History

sidebar_label
ElementHandle.screenshot

ElementHandle.screenshot() method

This method scrolls element into view if needed, and then uses to take a screenshot of the element. If the element is detached from DOM, the method throws an error.

Signature:

class ElementHandle {
  screenshot(
    this: ElementHandle<Element>,
    options?: ScreenshotOptions
  ): Promise<string | Buffer>;
}

Parameters

Parameter Type Description
this ElementHandle<Element>
options ScreenshotOptions (Optional)

Returns:

Promise<string | Buffer>