Skip to content
ScreenCI

ScreenCIConfig

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

Defined in: types.ts:732

Type Declaration

Section titled “Type Declaration”

envFile?

Section titled “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

Section titled “Example”
'.env'

projectName

Section titled “projectName”

projectName: string

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

projects?

Section titled “projects?”

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

record?

Section titled “record?”

optional record?: object

Options that only affect the screenci record command.

record.upload?

Section titled “record.upload?”

optional upload?: RecordUploadPolicy

Controls whether recordings are uploaded after partial Playwright failures.

Default
Section titled “Default”
'passed-only'

test?

Section titled “test?”

optional test?: object

Options that only affect the screenci test command.

test.mockRecord?

Section titled “test.mockRecord?”

optional mockRecord?: boolean

Keeps recording-style timings enabled during screenci test. Equivalent to passing --mock-record on the CLI.

Default
Section titled “Default”
false

use?

Section titled “use?”

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

Type Declaration

Section titled “Type Declaration”
actionTimeout?
Section titled “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
Section titled “Default”
30000
Section titled “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
Section titled “Default”
30000
recordOptions?
Section titled “recordOptions?”

optional recordOptions?: RecordOptions

renderOptions?
Section titled “renderOptions?”

optional renderOptions?: RenderOptions

trace?
Section titled “trace?”

optional trace?: NonNullable<NonNullable<PlaywrightTestConfig["use"]>["trace"]>

When to record traces during test execution. Uses Playwright’s native trace option type.

Default
Section titled “Default”
'retain-on-failure'

videoDir?

Section titled “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'.

webServer?

Section titled “webServer?”

optional webServer?: PlaywrightTestConfig["webServer"]

Starts and reuses a development server through Playwright before running videos.

This is useful for generated ScreenCI projects that should record against the app in the parent project directory.