schickling/chromeless

Ability to change image type and quality on screenshot

Open

#256 opened on Aug 21, 2017

View on GitHub
 (0 comments) (8 reactions) (0 assignees)TypeScript (13,240 stars) (606 forks)batch import
APIfeaturehelp wanted

Description

I wanted to use jpeg to capture screenshots with lower quality so I can render the screenshots much faster (which has typically been the case when using other tools like phantomJS).

The current API doesn't have support for these customization when generating a screenshot. Capture screenshot method supports image format and quality (as well as some other options): https://chromedevtools.github.io/devtools-protocol/tot/Page/#method-captureScreenshot

It would be great if the chromeless API had support for this. Seems like PDF options are already supported and is just a passthrough to the CDT: https://github.com/graphcool/chromeless/blob/master/src/api.ts#L234

Would be great to expose something similar for captureScreenshot

Thanks!

Contributor guide

Tech stack
typescriptnodejs
Domain
testingtooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScriptNode.jschromeless APIChrome DevTools Protocol
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Examine src/api.ts line 234 for the PDF passthrough pattern and implement similar parameter forwarding for the captureScreenshot method. Refer to the Chrome DevTools Protocol documentation for captureScreenshot parameters. Ensure new options are correctly typed and passed to the underlying CDP call.