openDemoVault
Downloads and opens the plugin’s demo vault in a new Obsidian window. Desktop only.
If the installed plugin version is the latest (or newer), its demo vault opens directly; otherwise the user chooses between the latest and the currently-installed version. A progress notice is shown immediately. The chosen version’s archive is downloaded once (then reused from the archive cache), but a fresh copy is extracted into its own temporary folder on every open — the vault is never reused across sessions.
Import:
import { openDemoVault } from 'obsidian-dev-utils/obsidian/desktop-demo-vault-opener';Signature:
function openDemoVault(params: OpenDemoVaultParams): Promise<void>Parameters:
| Parameter | Type | Description |
|---|---|---|
params | OpenDemoVaultParams | The OpenDemoVaultParams. |
Returns: Promise<void> — A Promise that resolves once the vault has been opened, or once the operation has been reported as not possible (notice shown) or cancelled by the user.
Links to this page: