Lupa

Appearance

Lupa API Reference / commands / PageScreenshotOptions

Interface: PageScreenshotOptions ​

Defined in: src/commands/screenshot.ts:7

Options for taking a page screenshot.

Properties ​

fullPage? ​

optional fullPage?: boolean

Defined in: src/commands/screenshot.ts:26

When true, takes a screenshot of the full scrollable page, instead of the visible viewport.

omitBackground? ​

optional omitBackground?: boolean

Defined in: src/commands/screenshot.ts:31

Hides default white background and allows capturing screenshots with transparency.

path ​

path: string

Defined in: src/commands/screenshot.ts:11

The file path to save the screenshot to.

quality? ​

optional quality?: number

Defined in: src/commands/screenshot.ts:21

The quality of the image, between 0-100. Only for jpeg.

timeout? ​

optional timeout?: number

Defined in: src/commands/screenshot.ts:36

Maximum time in milliseconds. Defaults to 30000.

type? ​

optional type?: "png" | "jpeg"

Defined in: src/commands/screenshot.ts:16

The image format. Defaults to 'png'.