Skip to content

TemporaryVault.dispose method

TemporaryVault › dispose

Unregisters the vault from Obsidian and, when this handle owns the directory, deletes it.

The directory is removed only when this instance created it, or when TemporaryVaultConstructorOptions.shouldRemoveDirectoryOnDispose said so explicitly. That is what makes a handle over a directory somebody else owns — the run's shared setup vault, say, which getTemporaryVault() wraps — safe to dispose from a consumer's afterAll.

Signature:

dispose(transportOverride?: ObsidianTransport | undefined): Promise<void>

Parameters:

ParameterTypeDescription
transportOverride?ObsidianTransport | undefinedAn explicit transport to use when unregistering. When omitted, falls back to the transport configured via the context provider.

Returns: Promise<void>