Documentation / screenshots / ScreenshotsClient

Class: ScreenshotsClient

Defined in: screenshots/src/client.ts:14

Extends

• GeneratedScreenshotsClient

Constructors

Constructor

new ScreenshotsClient(options?): ScreenshotsClient

Defined in: screenshots/src/client.ts:17

Parameters

Parameter	Type
options?	BrowserStackOptions

Returns

ScreenshotsClient

Overrides

GeneratedScreenshotsClient.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
authHeader?	readonly	string	GeneratedScreenshotsClient.authHeader	core/src/api-client.ts:50
baseUrls	readonly	object	GeneratedScreenshotsClient.baseUrls	core/src/api-client.ts:49
baseUrls.sdk	public	string	-	core/src/api-client.ts:49
baseUrls.sdkCloud	public	string	-	core/src/api-client.ts:49
fetchFn	readonly	(input, init?) => Promise<Response>	GeneratedScreenshotsClient.fetchFn	core/src/api-client.ts:52
registry	readonly	CodecRegistry	GeneratedScreenshotsClient.registry	core/src/api-client.ts:53
userAgent	readonly	string	GeneratedScreenshotsClient.userAgent	core/src/api-client.ts:51

Methods

createJob()

createJob(body, options?): Promise<object & object>

Defined in: screenshots/src/client.ts:27

Take a screenshot of a website on a particular browser

Parameters

Parameter	Type
body	{ browsers: object[]; callbackUrl?: string; local?: boolean; macRes?: string; orientation?: "portrait" | "landscape"; quality?: "Compressed" | "Original"; url: string; waitTime?: number; winRes?: string; }
body.browsers	object[]
body.callbackUrl?	string
body.local?	boolean
body.macRes?	string
body.orientation?	"portrait" | "landscape"
body.quality?	"Compressed" | "Original"
body.url?	string
body.waitTime?	number
body.winRes?	string
options?	ExecuteOptions

Returns

Promise<object & object>

Overrides

GeneratedScreenshotsClient.createJob

---

execute()

protected execute<T>(spec): Promise<T>

Defined in: core/src/api-client.ts:103

Internal

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
spec	{[key: string]: unknown; baseUrl?: "sdk" | "sdkCloud"; method: HttpMethod; operationId: string; params?: { path?: Record<string, unknown>; query?: Record<string, unknown>; }; path: string; requestCodec?: string; requestCodecConfig?: unknown; requestInput?: unknown; responseCodec: string; responseCodecConfig: unknown; signal?: AbortSignal; }
spec.baseUrl?	"sdk" | "sdkCloud"
spec.method	HttpMethod
spec.operationId	string
spec.params?	{ path?: Record<string, unknown>; query?: Record<string, unknown>; }
spec.params.path?	Record<string, unknown>
spec.params.query?	Record<string, unknown>
spec.path	string
spec.requestCodec?	string
spec.requestCodecConfig?	unknown
spec.requestInput?	unknown
spec.responseCodec	string
spec.responseCodecConfig	unknown
spec.signal?	AbortSignal

Returns

Promise<T>

Inherited from

GeneratedScreenshotsClient.execute

---

getBrowsers()

getBrowsers(options?): Promise<object[]>

Defined in: openapi/generated/screenshots.client.ts:67

Fetches list of browsers supported by Screenshots API

Parameters

Parameter	Type
options?	ExecuteOptions

Returns

Promise<object[]>

Inherited from

GeneratedScreenshotsClient.getBrowsers

---

getJob()

getJob(jobId, options?): Promise<object & object>

Defined in: screenshots/src/client.ts:37

Fetches a screenshot job

Parameters

Parameter	Type
jobId	string
options?	ExecuteOptions

Returns

Promise<object & object>

Overrides

GeneratedScreenshotsClient.getJob

---

launch()

launch(body, onScreenshot?, options?): Promise<DeepCamelCase<object & ({ device: string; browser?: string | undefined; browser_version?: string | undefined; } | { browser: string; browser_version: string; }) & { image_url?: string | undefined; thumb_url?: string | undefined; created_at?: string | undefined; }>[]>

Defined in: screenshots/src/client.ts:100

Parameters

Parameter	Type
body	{ browsers: object[]; callbackUrl?: string; local?: boolean; macRes?: string; orientation?: "portrait" | "landscape"; quality?: "Compressed" | "Original"; url: string; waitTime?: number; winRes?: string; }
body.browsers	object[]
body.callbackUrl?	string
body.local?	boolean
body.macRes?	string
body.orientation?	"portrait" | "landscape"
body.quality?	"Compressed" | "Original"
body.url?	string
body.waitTime?	number
body.winRes?	string
onScreenshot?	(screenshot) => void | Promise<void>
options?	ExecuteOptions & object

Returns

Promise<DeepCamelCase<object & ({ device: string; browser?: string | undefined; browser_version?: string | undefined; } | { browser: string; browser_version: string; }) & { image_url?: string | undefined; thumb_url?: string | undefined; created_at?: string | undefined; }>[]>

---

trackJob()

trackJob(jobId, onScreenshot?, options?, pollInterval?): Promise<DeepCamelCase<object & ({ device: string; browser?: string | undefined; browser_version?: string | undefined; } | { browser: string; browser_version: string; }) & { image_url?: string | undefined; thumb_url?: string | undefined; created_at?: string | undefined; }>[]>

Defined in: screenshots/src/client.ts:47

Parameters

Parameter	Type	Default value
jobId	string	undefined
onScreenshot?	(screenshot) => void | Promise<void>	undefined
options?	ExecuteOptions	undefined
pollInterval?	number	10_000

Returns

Promise<DeepCamelCase<object & ({ device: string; browser?: string | undefined; browser_version?: string | undefined; } | { browser: string; browser_version: string; }) & { image_url?: string | undefined; thumb_url?: string | undefined; created_at?: string | undefined; }>[]>