core/dev.kdriver.core.browser

Package-level declarations

Types

Represents a browser instance that can be controlled programmatically.

data class BrowserSearchConfig(val pathSeparator: String, val searchInPath: Boolean = true, val searchMacosApplications: Boolean = false, val searchWindowsProgramFiles: Boolean = false, val searchLinuxCommonPaths: Boolean = false)

Browser search configuration flags

BrowserTarget

interface BrowserTarget

Config

class Config(userDataDir: Path? = null, val headless: Boolean = Defaults.HEADLESS, val userAgent: String? = null, browserExecutablePath: Path? = null, browserArgs: List<String>? = null, sandbox: Boolean = Defaults.SANDBOX, val lang: String? = null, var host: String? = null, var port: Int? = null, val expert: Boolean = Defaults.EXPERT, val browserConnectionTimeout: Long = Defaults.BROWSER_CONNECTION_TIMEOUT, val browserConnectionMaxTries: Int = Defaults.BROWSER_CONNECTION_MAX_TRIES, val autoDiscoverTargets: Boolean = Defaults.AUTO_DISCOVER_TARGETS)

ConfigBuilder

class ConfigBuilder

Builder class for creating Config instances using Kotlin DSL syntax.

ContraDict

@Serializable

data class ContraDict(val webSocketDebuggerUrl: String)

DefaultBrowser

open class DefaultBrowser(val coroutineScope: CoroutineScope, val config: Config) : Browser

Default implementation of the Browser interface.

HTTPApi

class HTTPApi(host: String, port: Int)

Process

expect abstract class Process

actual abstract class Process

actual typealias Process = java.lang.Process

actual abstract class Process

WebSocketInfo

data class WebSocketInfo(val host: String, val port: Int, val path: String)

Functions

addShutdownHook

expect fun addShutdownHook(hook: suspend () -> Unit)

actual fun addShutdownHook(hook: suspend () -> Unit)

config

fun config(block: ConfigBuilder.() -> Unit): Config

Creates a Config instance using Kotlin DSL syntax.

createBrowser

suspend fun createBrowser(coroutineScope: CoroutineScope, config: Config): Browser

suspend fun createBrowser(coroutineScope: CoroutineScope, userDataDir: Path? = null, headless: Boolean = false, userAgent: String? = null, browserExecutablePath: Path? = null, browserArgs: List<String>? = null, sandbox: Boolean = true, lang: String? = null, host: String? = null, port: Int? = null): Browser

The entry point for creating a new Browser instance.