Mika Scraper / ScreenshotRequest

Interface: ScreenshotRequest

Defined in: src/_other-scraper/ssweb.ts:6

Represents the payload required to request a screenshot from the Imagy API.

Properties

url

url: string

The URL from which the screenshot is to be captured. This property is required.

Defined in: src/_other-scraper/ssweb.ts:7

browserWidth?

optional browserWidth: number

Specifies the viewport width in pixels. If not provided, a default width will be used.

Defined in: src/_other-scraper/ssweb.ts:8

browserHeight?

optional browserHeight: number

Specifies the viewport height in pixels. If not provided, a default height will be used.

Defined in: src/_other-scraper/ssweb.ts:9

fullPage?

optional fullPage: boolean

Indicates whether to capture the entire page or just the viewport. Defaults to false if not specified.

Defined in: src/_other-scraper/ssweb.ts:10

deviceScaleFactor?

optional deviceScaleFactor: number

Sets the device scale factor. For example, a value of 2 will produce a device pixel ratio of 2. Default is 1.

Defined in: src/_other-scraper/ssweb.ts:11

format?

optional format: "png" | "jpeg"

The image format for the screenshot. Defaults to "png" if not specified.

Defined in: src/_other-scraper/ssweb.ts:12

Example


const screenshotRequest: ScreenshotRequest = {
    url: 'https://example.com',
    browserWidth: 1920,
    browserHeight: 1080,
    fullPage: true,
    deviceScaleFactor: 2,
    format: 'jpeg'
};