Skip to content

transport-options

Discriminated union types for configuring the Obsidian transport via vitest environmentOptions.

Interface Description
ObsidianAndroidAppiumTransportOptions Transport options for Android testing via Appium WebView injection.
ObsidianCdpTransportOptions Transport options for desktop testing via Chrome DevTools Protocol. This is the default desktop transport. By default the harness launches and owns an isolated Obsidian instance in a temporary user-data dir (never touching the user’s Obsidian), connected over a free CDP port. Provide ObsidianCdpTransportOptions.port to instead attach to an already-running Obsidian.
Function Description
checkIsMobileTransport Whether these options describe a mobile transport. The same fact as ObsidianTransport.isMobile, but knowable from the options alone — so a caller can act on it before paying for a device. Reading it off a live transport means booting the emulator and the Appium session first, which is ~70 s to learn something the discriminant already says.
Type Description
ObsidianTransportOptions Discriminated union of all supported transport configurations. Used in vitest environmentOptions.obsidianTransport to select and configure the transport for integration tests.