thunderstrike/puppeteer
thunderstrike/puppeteer
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
34ff00e2fe
puppeteer/website/versioned_docs/version-10.0.0/puppeteer.page.screenshot.md
TASNEEM KOUSHAR 34ff00e2fe
chore(docs): generate site for v10.0.0 
* fix: added parts of website

* fix: removed unnecessary lines

* fix: updated contributing.md

* fix: added parts of sidebar

* fix: added all APIs

* fix: added version 10.0.0

Co-authored-by: Jack Franklin <jacktfranklin@chromium.org>
2021-08-09 09:57:14 +01:00

1.9 KiB
Raw Blame History

Home > puppeteer > Page > screenshot

Page.screenshot() method

Signature:

screenshot(options?: ScreenshotOptions): Promise<Buffer | string | void>;

Parameters

Parameter Type Description
options ScreenshotOptions

Returns:

Promise<Buffer | string | void>

Promise which resolves to buffer or a base64 string (depending on the value of encoding) with captured screenshot.

Remarks

Options object which might have the following properties:

  • path : The file path to save the image to. The screenshot type will be inferred from file extension. If path is a relative path, then it is resolved relative to current working directory. If no path is provided, the image won't be saved to the disk.

  • type : Specify screenshot type, can be either jpeg or png. Defaults to 'png'.

  • quality : The quality of the image, between 0-100. Not applicable to png images.

  • fullPage : When true, takes a screenshot of the full scrollable page. Defaults to false

  • clip : An object which specifies clipping region of the page. Should have the following fields:
    - x : x-coordinate of top-left corner of clip area.
    - y : y-coordinate of top-left corner of clip area.
    - width : width of clipping area.
    - height : height of clipping area.

  • omitBackground : Hides default white background and allows capturing screenshots with transparency. Defaults to false

  • encoding : The encoding of the image, can be either base64 or binary. Defaults to binary.

NOTE: Screenshots take at least 1/6 second on OS X. See https://crbug.com/741689 for discussion.