🤖 I have created a release *beep* *boop* --- <details><summary>puppeteer: 19.6.0</summary> ## [19.6.0](https://github.com/puppeteer/puppeteer/compare/puppeteer-v19.5.2...puppeteer-v19.6.0) (2023-01-23) ### Miscellaneous Chores * **puppeteer:** Synchronize puppeteer versions ### Dependencies * The following workspace dependencies were updated * dependencies * puppeteer-core bumped from 19.5.2 to 19.6.0 </details> <details><summary>puppeteer-core: 19.6.0</summary> ## [19.6.0](https://github.com/puppeteer/puppeteer/compare/puppeteer-core-v19.5.2...puppeteer-core-v19.6.0) (2023-01-23) ### Features * **chromium:** roll to Chromium 110.0.5479.0 (r1083080) ([#9500](https://github.com/puppeteer/puppeteer/issues/9500)) ([06e816b
](06e816bbfa
)), closes [#9470](https://github.com/puppeteer/puppeteer/issues/9470) * **page:** Adding support for referrerPolicy in `page.goto` ([#9561](https://github.com/puppeteer/puppeteer/issues/9561)) ([e3d69ec
](e3d69ec554
)) ### Bug Fixes * firefox revision resolution should not update chrome revision ([#9507](https://github.com/puppeteer/puppeteer/issues/9507)) ([f59bbf4
](f59bbf4014
)), closes [#9461](https://github.com/puppeteer/puppeteer/issues/9461) * improve screenshot method types ([#9529](https://github.com/puppeteer/puppeteer/issues/9529)) ([6847f88
](6847f8835f
)) </details> --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2.6 KiB
sidebar_label |
---|
Page.screenshot |
Page.screenshot() method
Signature:
class Page {
screenshot(
options: ScreenshotOptions & {
encoding: 'base64';
}
): Promise<string>;
}
Parameters
Parameter | Type | Description |
---|---|---|
options | ScreenshotOptions & { encoding: 'base64'; } |
Returns:
Promise<string>
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. Ifpath
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 eitherjpeg
orpng
. Defaults to 'png'. -
quality
: The quality of the image, between 0-100. Not applicable topng
images. -
fullPage
: When true, takes a screenshot of the full scrollable page. Defaults tofalse
. -
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 tofalse
. -
encoding
: The encoding of the image, can be either base64 or binary. Defaults tobinary
. -
captureBeyondViewport
: When true, captures screenshot beyond the viewport. When false, falls back to old behaviour, and cuts the screenshot by the viewport size. Defaults totrue
. -
fromSurface
: When true, captures screenshot from the surface rather than the view. When false, works only in headful mode and ignores page viewport (but not browser window's bounds). Defaults totrue
.
NOTE: Screenshots take at least 1/6 second on OS X. See https://crbug.com/741689 for discussion.