Skip to main content
Version: 1.x

Function: defineConfig()

defineConfig(input): object

Defined in: src/core/config/loader.ts:209

Type helper for Praman config files — returns input unchanged.

Parameters​

input​

Config input to pass through.

ai?​

{ anthropicApiKey?: string; apiKey?: string; apiVersion?: string; deployment?: string; endpoint?: string; maxTokens?: number; model?: string; provider?: "openai" | "azure-openai" | "anthropic"; temperature?: number; } = ...

ai.anthropicApiKey?​

string = ...

ai.apiKey?​

string = ...

ai.apiVersion?​

string = ...

ai.deployment?​

string = ...

ai.endpoint?​

string = ...

ai.maxTokens?​

number = ...

ai.model?​

string = ...

ai.provider?​

"openai" | "azure-openai" | "anthropic" = ...

ai.temperature?​

number = ...

auth?​

{ baseUrl: string; client?: string; language?: string; password?: string; strategy?: "custom" | "btp-saml" | "basic" | "office365"; username?: string; } = ...

auth.baseUrl​

string = ...

auth.client?​

string = ...

auth.language?​

string = ...

auth.password?​

string = ...

auth.strategy?​

"custom" | "btp-saml" | "basic" | "office365" = ...

auth.username?​

string = ...

controlDiscoveryTimeout?​

number = ...

discoveryStrategies?​

("direct-id" | "recordreplay" | "registry")[] = ...

ignoreAutoWaitUrls?​

string[] = ...

interactionStrategy?​

"ui5-native" | "dom-first" | "opa5" = ...

logLevel?​

"error" | "debug" | "warn" | "info" | "verbose" = ...

opa5?​

{ autoWait?: boolean; debug?: boolean; interactionTimeout?: number; } = ...

opa5.autoWait?​

boolean = ...

opa5.debug?​

boolean = ...

opa5.interactionTimeout?​

number = ...

preferVisibleControls?​

boolean = ...

selectors?​

{ defaultTimeout?: number; preferVisibleControls?: boolean; skipStabilityWait?: boolean; } = ...

selectors.defaultTimeout?​

number = ...

selectors.preferVisibleControls?​

boolean = ...

selectors.skipStabilityWait?​

boolean = ...

skipStabilityWait?​

boolean = ...

telemetry?​

{ endpoint?: string; exporter?: "otlp" | "azure-monitor" | "jaeger"; openTelemetry?: boolean; serviceName?: string; } = ...

telemetry.endpoint?​

string = ...

telemetry.exporter?​

"otlp" | "azure-monitor" | "jaeger" = ...

telemetry.openTelemetry?​

boolean = ...

telemetry.serviceName?​

string = ...

ui5WaitTimeout?​

number = ...

Returns​

object

The input unchanged.

ai?​

optional ai: object

ai.anthropicApiKey?​

optional anthropicApiKey: string

ai.apiKey?​

optional apiKey: string

ai.apiVersion?​

optional apiVersion: string

ai.deployment?​

optional deployment: string

ai.endpoint?​

optional endpoint: string

ai.maxTokens?​

optional maxTokens: number

ai.model?​

optional model: string

ai.provider?​

optional provider: "openai" | "azure-openai" | "anthropic"

ai.temperature?​

optional temperature: number

auth?​

optional auth: object

auth.baseUrl​

baseUrl: string

auth.client?​

optional client: string

auth.language?​

optional language: string

auth.password?​

optional password: string

auth.strategy?​

optional strategy: "custom" | "btp-saml" | "basic" | "office365"

auth.username?​

optional username: string

controlDiscoveryTimeout?​

optional controlDiscoveryTimeout: number

discoveryStrategies?​

optional discoveryStrategies: ("direct-id" | "recordreplay" | "registry")[]

ignoreAutoWaitUrls?​

optional ignoreAutoWaitUrls: string[]

interactionStrategy?​

optional interactionStrategy: "ui5-native" | "dom-first" | "opa5"

logLevel?​

optional logLevel: "error" | "debug" | "warn" | "info" | "verbose"

opa5?​

optional opa5: object

opa5.autoWait?​

optional autoWait: boolean

opa5.debug?​

optional debug: boolean

opa5.interactionTimeout?​

optional interactionTimeout: number

preferVisibleControls?​

optional preferVisibleControls: boolean

selectors?​

optional selectors: object

selectors.defaultTimeout?​

optional defaultTimeout: number

selectors.preferVisibleControls?​

optional preferVisibleControls: boolean

selectors.skipStabilityWait?​

optional skipStabilityWait: boolean

skipStabilityWait?​

optional skipStabilityWait: boolean

telemetry?​

optional telemetry: object

telemetry.endpoint?​

optional endpoint: string

telemetry.exporter?​

optional exporter: "otlp" | "azure-monitor" | "jaeger"

telemetry.openTelemetry?​

optional openTelemetry: boolean

telemetry.serviceName?​

optional serviceName: string

ui5WaitTimeout?​

optional ui5WaitTimeout: number

Remarks​

Used in praman.config.ts for IDE autocomplete and type checking.

Example​

// praman.config.ts
import { defineConfig } from 'playwright-praman';
export default defineConfig({ logLevel: 'debug' });