Skip to content

CommonArguments

Common arguments automatically provided to every evalInObsidian callback.

Import:

import type { CommonArguments } from 'obsidian-integration-testing';

Signature:

export interface CommonArguments

Properties

PropertyTypeDescription
appAppThe Obsidian App instance.
libLibThe shared library bag injected into every callback — see Lib.

Never empty: the harness pre-populates a **base** set of renderer-driving helpers (trusted input — typeIntoEditor / pressKey / moveMouse / clickMouse / hoverElement / unhoverElement / clickElement — plus waitUntil, createNote and openSettingsTab), and provider packages (chiefly obsidian-dev-utils) Object.assign their whole renderer-safe library on top via registerLibResolver. A serialized closure reaches every shared helper through liblib.typeIntoEditor({ editor, text }), lib.getFileOrNull({ app, … }) — instead of importing or hand-rolling them.
obsidianModuletypeof obsidianThe obsidian module, resolved at runtime inside the Obsidian process.

Links to this page: