Skip to content
ScreenCI

defineConfig

defineConfig(config): ExtendedScreenCIConfig

Defined in: config.ts:47

Defines a screenci configuration file.

Extends Playwright’s config with screenci-specific options. retries, testDir, and testMatch are managed by screenci and cannot be set.

Parameters

Section titled “Parameters”

config

Section titled “config”

ScreenCIConfig

screenci configuration options

Returns

Section titled “Returns”

ExtendedScreenCIConfig

Extended Playwright configuration with screenci-managed test discovery

Examples

Section titled “Examples”

Minimal — all options have sensible defaults:

import { defineConfig } from 'screenci'
export default defineConfig({})
import { defineConfig } from 'screenci'


export default defineConfig({
  projectName: 'my-project',
  recordingDir: './recordings',
  use: {
    baseURL: 'https://app.example.com',
    trace: 'retain-on-failure',
  },
})

Record and render options are declared per video with video.recordOptions(...) / video.renderOptions(...) (code values are the starting point and stay editable in the web editor), not at config level.