PlaywrightServerOptions

Defined in: runner-playwright/src/remote/playwright-server.ts:6

Options of playwrightServer.

Properties

connectTimeoutMs?

optional connectTimeoutMs?: number

Defined in: runner-playwright/src/remote/playwright-server.ts:34

How long one connect attempt waits in ms (default 30 000). A server started with --max-clients queues extra connections: raise this when renders outnumber its clients.

---

endpoint

endpoint: string

Defined in: runner-playwright/src/remote/playwright-server.ts:10

ws://host:3000/ or wss://…: the server’s address and --path.

---

engines?

optional engines?: readonly BrowserName[]

Defined in: runner-playwright/src/remote/playwright-server.ts:27

Engines to offer (default all three; the server must have them installed).

---

exposeNetwork?

optional exposeNetwork?: string | false

Defined in: runner-playwright/src/remote/playwright-server.ts:23

Route the remote browser’s requests for the loopback Storybook server back through the connection (default "<loopback>"). false when the server cannot, which makes every target need a signed Storybook URL.

---

headers?

optional headers?: Record<string, string>

Defined in: runner-playwright/src/remote/playwright-server.ts:17

Further handshake headers.

---

name?

optional name?: string

Defined in: runner-playwright/src/remote/playwright-server.ts:8

The target name half (chromium@<name>); default grid.

---

platform?

optional platform?: string

Defined in: runner-playwright/src/remote/playwright-server.ts:29

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

---

sessions?

optional sessions?: number

Defined in: runner-playwright/src/remote/playwright-server.ts:25

Parallel pages the farm should take from this runner (default 1: set it to the farm’s cap).

---

token?

optional token?: string

Defined in: runner-playwright/src/remote/playwright-server.ts:15

Bearer token for a reverse proxy in front of the server: a bare run-server has no authentication of its own. Sent as authorization: Bearer ….