Skip to content
Obsidian Integration Testing
v17.10.0
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Menu
Guides
Getting started
Writing tests
Simulating user input
The `lib` bag
Vaults and fixtures
Transport modes
Android testing
Version matrix
Leftover cleanup
Ad-hoc debugging
Driving Obsidian from an agent
Plugin lifecycle patterns
Sync and Publish
API reference
android
adb
adb
Overview
runAdbBinary
RunAdbParams
runAdbText
runAdbTextWithoutDevice
appium
transport-appium
Overview
AppiumSessionInfo
AppiumTransport
AppiumTransportConfig
avd
emulator-device-id
Overview
EmulatorDeviceCandidate
selectEmulatorDeviceId
SelectEmulatorDeviceIdParams
resolve-emulator-device-id
Overview
resolveEmulatorDeviceId
ResolveEmulatorDeviceIdParams
device-setting-restore
Overview
DeviceSettingRestore
DeviceSettingRestoreDelete
DeviceSettingRestoreKind
DeviceSettingRestoreWrite
resolveDeviceSettingRestore
device-settings
Overview
deleteDeviceSetting
DeviceSettingParams
readDeviceSetting
withSoftKeyboardEnabled
WithSoftKeyboardEnabledParams
writeDeviceSetting
WriteDeviceSettingParams
device-settings-command
Overview
buildDeviceSettingsCommandArguments
BuildDeviceSettingsCommandArgumentsParams
DeviceSettingNamespace
DeviceSettingVerb
soft-keyboard
soft-keyboard
Overview
raiseSoftKeyboard
RaiseSoftKeyboardParams
tapDevice
TapDeviceParams
soft-keyboard-geometry
Overview
buildSoftKeyboardDiagnosticMessage
BuildSoftKeyboardDiagnosticMessageParams
checkIsInputMethodShown
checkIsSoftKeyboardUp
CheckIsSoftKeyboardUpParams
DEFAULT_MINIMUM_KEYBOARD_HEIGHT_IN_PIXELS
ElementRect
parseInputMethodState
resolveSoftKeyboardTapPoints
ResolveSoftKeyboardTapPointsParams
SoftKeyboardTapPoint
SoftKeyboardViewportSnapshot
capture
apply-obsidian-theme
Overview
applyObsidianTheme
ApplyObsidianThemeParams
assertObsidianThemeUnchanged
AssertObsidianThemeUnchangedParams
ObsidianTheme
capture-obsidian-screenshot
Overview
captureObsidianScreenshot
CaptureObsidianScreenshotOptions
capture-screenshot
Overview
buildDeviceMetricsOverride
CaptureScreenshotParams
decodeBase64Png
isPng
PngDimensions
readPngDimensions
device-screenshot
Overview
captureDeviceScreenshot
CaptureDeviceScreenshotParams
fit-screenshot
Overview
computeFitToCanvas
ComputeFitToCanvasParams
fitScreenshotToCanvas
FitScreenshotToCanvasOptions
FitToCanvasGeometry
hide-caret
Overview
HiddenCaret
hideCaret
HideCaretOptions
hide-vault-name
Overview
hideVaultName
HideVaultNameOptions
label-screenshot
Overview
buildLabelSvg
computeLabelBand
ComputeLabelBandParams
escapeSvgText
LabelBandGeometry
LabelCaptionMeasurement
labelScreenshot
LabelScreenshotOptions
measureLabelCaption
MeasureLabelCaptionParams
paint-out-status-bar
Overview
buildStatusBarBandFailureMessage
BuildStatusBarBandFailureMessageParams
DEFAULT_STATUS_BAR_EDGE_MARGIN_IN_PIXELS
DEFAULT_STATUS_BAR_SAMPLE_INSET_IN_PIXELS
paintOutStatusBar
PaintOutStatusBarOptions
resolveStatusBarBand
ResolveStatusBarBandParams
StatusBarBandColor
StatusBarBandVerdict
pin-window-focus
Overview
PinnedWindowFocus
pinWindowFocus
PinWindowFocusOptions
desktop
cdp-command-timeout-error
Overview
CdpCommandTimeoutError
CdpCommandTimeoutErrorConstructorParams
compatibility
asar-fallback-detection
Overview
AsarFallback
AsarFallbackTier
resolveAsarFallback
ResolveAsarFallbackParams
electron-compatibility
Overview
ElectronCompatibility
ElectronCompatibilityTier
resolveElectronCompatibility
ResolveElectronCompatibilityParams
incompatible-installer-version-error
Overview
IncompatibleInstallerVersionError
IncompatibleInstallerVersionErrorConstructorParams
installer-compatibility
Overview
InstallerCompatibility
InstallerCompatibilityTier
resolveInstallerCompatibility
ResolveInstallerCompatibilityParams
renderer-failed-to-initialize-error
Overview
RendererFailedToInitializeError
silent-asar-fallback-error
Overview
SilentAsarFallbackError
SilentAsarFallbackErrorConstructorParams
config-directory
Overview
assertValidConfigDirectory
DEFAULT_CONFIG_DIRECTORY
config-directory-fallback-error
Overview
ConfigDirectoryFallbackError
ConfigDirectoryFallbackErrorConstructorParams
connect-to-cdp
Overview
CdpConnection
connectToCdp
ConnectToCdpOptions
owned-instance
owned-instance-exited-error
Overview
OwnedInstanceExitedError
OwnedInstanceExitedErrorConstructorParams
persistent-profile
Overview
PersistentProfileInUseError
PersistentProfileInUseErrorConstructorParams
PersistentProfileLock
transport-desktop-cdp
Overview
DesktopCdpTransport
DesktopCdpTransportConfig
OwnedInstanceAsar
OwnedInstanceConfig
OwnedInstanceEndpoint
versions
obsidian-metadata
Overview
getVersionMetadata
ObsidianRuntimeVersions
ObsidianVersionChangelogUrls
ObsidianVersionDownloads
ObsidianVersionMetadata
obsidian-version
Overview
CATALYST_LATEST
PUBLIC_LATEST
run-version-matrix
Overview
runObsidianVersionMatrix
RunObsidianVersionMatrixParams
version-matrix
Overview
DEFAULT_OBSIDIAN_VERSION_SPECS
ObsidianVersionMatrixEntry
eval
eval-cap
Overview
DEFAULT_EVAL_CAP_IN_MILLISECONDS
eval-cap-exceeded-error
Overview
EvalCapExceededError
EvalCapExceededErrorConstructorParams
isScriptTimeoutError
eval-in-obsidian
Overview
ClickElementParams
ClickMouseParams
CommitCompositionParams
CommonArguments
ComposeIntoEditorParams
CreateNoteParams
DragMouseParams
evalInObsidian
EvalInObsidianParams
GenericObject
HoverElementParams
Lib
MouseButton
MousePoint
MoveMouseParams
OpenSettingsTabParams
PressKeyParams
SetCompositionParams
TypeIntoEditorParams
UnhoverElementParams
WaitUntilParams
poll-in-obsidian
Overview
pollInObsidian
PollInObsidianParams
namespace
lib-registry
Overview
LibResolver
registerLibResolver
open-obsidian-settings-tab
Overview
openObsidianSettingsTab
OpenObsidianSettingsTabParams
plugin
desktop-only-plugin-skip-error
Overview
DesktopOnlyPluginSkipError
plugin-lifecycle
Overview
detectPluginUnloadLeak
DetectPluginUnloadLeakParams
PluginLifecycleTarget
PluginUnloadLeakResult
reloadPlugin
ReloadPluginParams
ReloadPluginResult
stale-build-error
Overview
StaleBuildError
StaleBuildErrorConstructorParams
transport
context-id
Overview
ContextArguments
ContextId
ContextOf
context-provider
Overview
setSetupErrorResolver
setTransportOptionsResolver
SetupErrorResolver
setVaultPathResolver
TransportOptionsResolver
VaultPathResolver
integration-setup-failed-error
Overview
IntegrationSetupFailedError
IntegrationSetupFailedErrorConstructorParams
transport
Overview
ConsoleCaptureHandle
ObsidianTransport
TransportEvalOptions
transport-factory
Overview
createTransportFromOptions
transport-options
Overview
checkIsMobileTransport
ObsidianAndroidAppiumTransportOptions
ObsidianCdpTransportOptions
ObsidianTransportOptions
vault
app-config
Overview
AppConfigRestore
getAppConfig
GetAppConfigParams
restoreAppConfig
setAppConfig
SetAppConfigParams
withAppConfig
WithAppConfigParams
demo-vault
demo-vault-bootstrap
Overview
bootstrapDemoVaultPlugins
BootstrapDemoVaultPluginsParams
BootstrapDemoVaultPluginsResult
buildDemoVaultPopulateAsync
BuildDemoVaultPopulateAsyncParams
InstalledPluginInfo
demo-vault-populate
Overview
buildDemoVaultPopulate
BuildDemoVaultPopulateParams
InjectPluginParams
resolveInjectedPluginStaleReason
ResolveInjectedPluginStaleReasonParams
resolveMissingInjectedPlugins
ResolveMissingInjectedPluginsParams
demo-vault-tree
Overview
readDemoVaultTree
ReadDemoVaultTreeParams
large-vault-generator
Overview
generateLargeVault
GenerateLargeVaultParams
temporary-vault
Overview
PopulateFileContent
PopulateFilesParams
TemporaryVault
TemporaryVaultConstructorOptions
vault-registry
Overview
registerVault
unregisterVault
GitHub
Select theme
Dark
Light
Auto
GenerateLargeVaultParams.tagCount?
GenerateLargeVaultParams
› tagCount?
Type:
number
How many distinct tags exist across the vault.