Skip to content

LaunchOptions

Namespace: E2E

public sealed record LaunchOptions : IEquatable<LaunchOptions>

What LaunchAsync is given. Upstream’s LaunchOptions (core/launch.ts).

Inheritance: object

Implements: IEquatable<LaunchOptions>

View source

public LaunchApp? App { get; init; }

The app: Url on a browser; BundleId or AppPath on a device.

Value: LaunchApp

public string? ArtifactsDir { get; init; }

Where screenshots, downloads, and recordings are written, from Cwd. Default: a fresh directory under the system temp directory, deleted when the host closes.

Value: string

public string? Cwd { get; init; }

The directory upload paths and relative files resolve against, ArtifactsDir included; default the current directory.

Value: string

public IReadOnlyDictionary<string, string?>? Env { get; init; }

The environment the engine reads; default the process environment.

Value: IReadOnlyDictionary<string, string>

public bool Headed { get; init; }

Shows the browser window; default false. Devices ignore it. Upstream’s headed.

Value: bool

public Action<string>? OnNotice { get; init; }

Progress outside operations: provisioning, downloads, device leases. Must not throw.

Value: Action<string>

public IReadOnlyDictionary<string, string>? Secrets { get; init; }

Secret values by name, at least 6 characters each. Fill one through Secret(string); an agent receives it by name only. The values are redacted from what Screen.Tree() and the agent read, and from the errors this host throws.

Value: IReadOnlyDictionary<string, string>

public TimeSpan? Timeout { get; init; }

Default timeout of one operation: an action, a wait, a read, and App.OpenAsync or App.RestartAsync. Without it an action, a wait, or a read gets 30 seconds, and an app open or restart 120 seconds. A session changes it with SetDefaultTimeout(TimeSpan). An agent step has its own, ActAsync’s timeout. There is no session deadline.

Value: TimeSpan?