thunderstrike/puppeteer
thunderstrike/puppeteer
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
afc7e3b770
puppeteer/website/versioned_docs/version-19.5.2/api/puppeteer.screenshotoptions.md
release-please[bot] e9df6750d2
chore: release main (#9495) 
🤖 I have created a release *beep* *boop*
---


<details><summary>puppeteer: 19.5.2</summary>

##
[19.5.2](https://github.com/puppeteer/puppeteer/compare/puppeteer-v19.5.1...puppeteer-v19.5.2)
(2023-01-11)


### Miscellaneous Chores

* **puppeteer:** Synchronize puppeteer versions


### Dependencies

* The following workspace dependencies were updated
  * dependencies
    * puppeteer-core bumped from 19.5.1 to 19.5.2
</details>

<details><summary>puppeteer-core: 19.5.2</summary>

##
[19.5.2](https://github.com/puppeteer/puppeteer/compare/puppeteer-core-v19.5.1...puppeteer-core-v19.5.2)
(2023-01-11)


### Bug Fixes

* make sure browser fetcher in launchers uses configuration
([#9493](https://github.com/puppeteer/puppeteer/issues/9493))
([df55439](df554397b5)),
closes [#9470](https://github.com/puppeteer/puppeteer/issues/9470)
</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>
2023-01-12 08:21:09 +01:00

4.8 KiB
Raw Blame History

sidebar_label
ScreenshotOptions

ScreenshotOptions interface

Signature:

export interface ScreenshotOptions

Properties

Property Modifiers Type Description Default
captureBeyondViewport? boolean (Optional) Capture the screenshot beyond the viewport. true
clip? ScreenshotClip (Optional) An object which specifies the clipping region of the page.
encoding? 'base64' | 'binary' (Optional) Encoding of the image. binary
fromSurface? boolean (Optional) Capture the screenshot from the surface, rather than the view. true
fullPage? boolean (Optional) When true, takes a screenshot of the full page. false
omitBackground? boolean (Optional) Hides default white background and allows capturing screenshots with transparency. false
path? string (Optional) 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.
quality? number (Optional) Quality of the image, between 0-100. Not applicable to png images.
type? 'png' | 'jpeg' | 'webp' (Optional) png