thunderstrike/puppeteer
thunderstrike/puppeteer
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat(screenshot): enable optimizeForSpeed (#10492)

Browse Source
This commit is contained in:
Kiko Beats 2023-07-03 11:43:34 +02:00 committed by GitHub
parent 5a3abb2f5e
commit 87aaed4807
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/api/puppeteer.screenshotoptions.md
View File

@ -20,6 +20,7 @@ export interface ScreenshotOptions
| fromSurface | <code>optional</code> | boolean | Capture the screenshot from the surface, rather than the view. | <code>true</code> | | fromSurface | <code>optional</code> | boolean | Capture the screenshot from the surface, rather than the view. | <code>true</code> |
| fullPage | <code>optional</code> | boolean | When <code>true</code>, takes a screenshot of the full page. | <code>false</code> | | fullPage | <code>optional</code> | boolean | When <code>true</code>, takes a screenshot of the full page. | <code>false</code> |
| omitBackground | <code>optional</code> | boolean | Hides default white background and allows capturing screenshots with transparency. | <code>false</code> | | omitBackground | <code>optional</code> | boolean | Hides default white background and allows capturing screenshots with transparency. | <code>false</code> |
| optimizeForSpeed | <code>optional</code> | boolean | | <code>false</code> |
| path | <code>optional</code> | string | 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. | | | path | <code>optional</code> | string | 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 | <code>optional</code> | number | Quality of the image, between 0-100. Not applicable to <code>png</code> images. | | | quality | <code>optional</code> | number | Quality of the image, between 0-100. Not applicable to <code>png</code> images. | |
| type | <code>optional</code> | 'png' \| 'jpeg' \| 'webp' | | <code>png</code> | | type | <code>optional</code> | 'png' \| 'jpeg' \| 'webp' | | <code>png</code> |

4
packages/puppeteer-core/src/api/Page.ts
View File

@ -170,6 +170,10 @@ export interface ScreenshotClip {
* @public * @public
*/ */
export interface ScreenshotOptions { export interface ScreenshotOptions {
/**
* @defaultValue `false`
*/
optimizeForSpeed?: boolean;
/** /**
* @defaultValue `png` * @defaultValue `png`
*/ */

1
packages/puppeteer-core/src/common/Page.ts
View File

@ -1267,6 +1267,7 @@ export class CDPPage extends Page {
const result = await this.#client.send('Page.captureScreenshot', { const result = await this.#client.send('Page.captureScreenshot', {
format, format,
optimizeForSpeed: options.optimizeForSpeed,
quality: options.quality, quality: options.quality,
clip: clip && { clip: clip && {
...clip, ...clip,