ScreenCIConfig

ScreenCIConfig = Omit<PlaywrightTestConfig, "fullyParallel" | "workers" | "retries" | "testDir" | "testMatch" | "use" | "projects"> & object

Defined in: types.ts:624

Type Declaration

envFile?

optional envFile?: string

Path to a .env file to load before uploading. Relative to the screenci.config.ts file. Use this to load SCREENCI_SECRET and other env vars.

Example

'.env'

projectName

projectName: string

Name of the project. Used to identify the project in screenci.com.

projects?

optional projects?: Omit<Project, "use"> & object[]

use?

optional use?: Omit<PlaywrightTestConfig["use"], "trace"> & object

Type Declaration

actionTimeout?

optional actionTimeout?: number

Timeout in milliseconds for individual actions like click(), fill(), etc.

Separate from the overall test timeout. Defaults to 30 seconds so actions don’t inherit the long test timeout.

Default

30000

navigationTimeout?

optional navigationTimeout?: number

Timeout in milliseconds for page navigations like goto(), waitForNavigation(), etc.

Separate from the overall test timeout. Defaults to 30 seconds.

Default

30000

recordOptions?

optional recordOptions?: RecordOptions

renderOptions?

optional renderOptions?: RenderOptions

sendTraces?

optional sendTraces?: boolean

Whether to send recorded traces to screenci.com for viewing and analysis.

When true, traces are uploaded and can be viewed on screenci.com. When false, traces are kept locally only.

Default

true

trace?

optional trace?: Trace

When to record traces during test execution.

Default

'retain-on-failure'

videoDir?

optional videoDir?: string

Directory that will be searched recursively for *.video.* files.

Matches files like example.video.ts, demo.video.js, etc.

Defaults to './videos'.