kylefang/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/zhigang1992/DefinitelyTyped.git synced 2026-05-30 18:43:21 +08:00
Code Issues Packages Projects Releases Wiki Activity

Extend screenshot encoding support (#28713)

Browse Source 
Overloaded the screenshot methods to define the return type based on what kind of encoding is used.
Edited the test and made sure normal ScreenshotOptions worked as normal still, the two new extended interfaces can be used for objects to pass in also but did not add test for that directly, should be handled right with the current test cases.
This commit is contained in:
Larry1123
2018-09-14 13:34:19 -04:00
committed by Ryan Cavanaugh
parent 21d31fd064
commit 192edcd269
2 changed files with 19 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
types/puppeteer/index.d.ts vendored
View File

@@ -592,6 +592,14 @@ export interface ScreenshotOptions {
encoding?: "base64" | "binary";
}
export interface BinaryScreenShotOptions extends ScreenshotOptions {
encoding?: "binary";
}
export interface Base64ScreenShotOptions extends ScreenshotOptions {
encoding: "base64";
}
/** Options for `addStyleTag` */
export interface StyleTagOptions {
/** Url of the <link> tag. */
@@ -747,7 +755,9 @@ export interface ElementHandle<E extends Element = Element> extends JSHandle, Ev
* If the element is detached from DOM, the method throws an error.
* @param options Same options as in page.screenshot.
*/
screenshot(options?: ScreenshotOptions): Promise<Buffer>;
screenshot(options?: Base64ScreenShotOptions): Promise<string>;
screenshot(options?: BinaryScreenShotOptions): Promise<Buffer>;
screenshot(options?: ScreenshotOptions): Promise<string | Buffer>;
/**
* This method scrolls element into view if needed, and then uses touchscreen.tap to tap in the center of the element.
* If the element is detached from DOM, the method throws an error.
@@ -1346,6 +1356,8 @@ export interface Page extends EventEmitter, FrameBase {
* Captures a screenshot of the page.
* @param options The screenshot options.
*/
screenshot(options?: Base64ScreenShotOptions): Promise<string>;
screenshot(options?: BinaryScreenShotOptions): Promise<Buffer>;
screenshot(options?: ScreenshotOptions): Promise<string | Buffer>;
/**

8
types/puppeteer/puppeteer-tests.ts
View File

@@ -403,8 +403,12 @@ puppeteer.launch().then(async browser => {
const browser = await puppeteer.launch();
const page = await browser.newPage();
await page.goto("https://example.com");
const base64string: string = (await page.screenshot({ encoding: "base64" })) as string;
const buffer: Buffer = (await page.screenshot({ encoding: "binary" })) as Buffer;
const base64string: string = await page.screenshot({ encoding: "base64" });
const buffer: Buffer = await page.screenshot({ encoding: "binary" });
const screenshotOptions: puppeteer.ScreenshotOptions = {
fullPage: true,
};
const stringOrBuffer: string | Buffer = await page.screenshot(screenshotOptions);
browser.close();
})();