CdpLeasedOptions

Defined in: packages/runner-puppeteer/src/remote/cdp.ts:46

A service that must be woken, started or chosen per connection: connect receives the run’s context (buildId, runId, shardIndex, purpose, attempt, signal) and returns { endpoint, headers, lease }; release gets the lease back once, when the render ends.

Extends

• CdpBase

Type Parameters

TLease

TLease

Properties

connect

connect: (context) => RemoteLeasedConnection<TLease> | Promise<RemoteLeasedConnection<TLease>>

Defined in: packages/runner-puppeteer/src/remote/cdp.ts:47

Parameters

context

RemoteConnectContext

Returns

RemoteLeasedConnection<TLease> | Promise<RemoteLeasedConnection<TLease>>

---

connectTimeoutMs?

optional connectTimeoutMs?: number

Defined in: packages/runner-puppeteer/src/remote/cdp.ts:28

How long one connect attempt waits in ms (default 30 000).

Inherited from

CdpBase.connectTimeoutMs

---

endpoint?

optional endpoint?: undefined

Defined in: packages/runner-puppeteer/src/remote/cdp.ts:53

---

engines?

optional engines?: readonly BrowserName[]

Defined in: packages/runner-puppeteer/src/remote/cdp.ts:24

Engines to offer (default chromium; chrome when the service is real Chrome).

Inherited from

CdpBase.engines

---

headers?

optional headers?: undefined

Defined in: packages/runner-puppeteer/src/remote/cdp.ts:54

---

name

name: string

Defined in: packages/runner-puppeteer/src/remote/cdp.ts:20

The target name half (chromium@<name>): lowercase letters, digits and hyphens, at most 32.

Inherited from

CdpBase.name

---

platform?

optional platform?: string

Defined in: packages/runner-puppeteer/src/remote/cdp.ts:26

OS the service runs on, reported when the page cannot tell.

Inherited from

CdpBase.platform

---

release?

optional release?: (lease, info) => void | Promise<void>

Defined in: packages/runner-puppeteer/src/remote/cdp.ts:48

Parameters

lease

TLease

info

RemoteReleaseInfo

Returns

void | Promise<void>

---

retry?

optional retry?: object

Defined in: packages/runner-puppeteer/src/remote/cdp.ts:50

Retries after the first connect attempt (default 3) and the first backoff in ms (default 500).

attempts?

optional attempts?: number

backoffMs?

optional backoffMs?: number

---

sessions?

optional sessions?: number | (() => number)

Defined in: packages/runner-puppeteer/src/remote/cdp.ts:22

Parallel pages the service allows (default 1: set it to the plan’s cap). A function is read live.

Inherited from

CdpBase.sessions

---

timeouts?

optional timeouts?: object

Defined in: packages/runner-puppeteer/src/remote/cdp.ts:52

acquireMs bounds connect, connectMs the handshake, releaseMs release (all default 30 000).

acquireMs?

optional acquireMs?: number

connectMs?

optional connectMs?: number

releaseMs?

optional releaseMs?: number